Interface: UnionBuilder<S>

Defined in: defineMigration.ts:84

Evolves a union within a SchemaUpdate. Obtain one from the SchemaBuilder and finish with build().

Type Parameters

S

S extends UnionVariants

Methods

addVariant()

addVariant<K>(name, modelDefOrRef): UnionBuilder<S & { [k in string]: Ref }>

Defined in: defineMigration.ts:87

Add a variant, referencing a record (or a Ref to one).

Type Parameters

K

K extends string

Parameters

name

K

modelDefOrRef

UnionVariantArg

Returns

UnionBuilder<S & { [k in string]: Ref }>

---

build()

build(): UnionDef<S>

Defined in: defineMigration.ts:92

Produce the updated UnionDef.

Returns

UnionDef<S>