Interface DiscriminatorSchema<K, M>

a schema for tagged unions of objects

interface DiscriminatorSchema<K, M> {
    discriminator: K;
    mapping: M;
    metadata?: unknown;
    nullable?: boolean;
}

Type Parameters

K extends string = string
M extends Readonly<Record<string, MappingSchema>> = Readonly<Record<string, MappingSchema>>

Index

Properties

discriminator mapping metadata? nullable?

Properties

`Readonly` discriminator

discriminator: K

the key for the discriminator in the type

`Readonly` mapping

mapping: M

a mapping of discriminator values to schemas

`Optional` `Readonly` metadata

metadata?: unknown

optional metadata on a schema

`Optional` `Readonly` nullable

nullable?: boolean

a key indicating if a type can be null