Skip to main content

Interface: SchemaVersionBuilder<T>

Defined in: defineSchemaUpdate.ts:101

Accumulates SchemaUpdates onto the previous version. Create one with nextSchema and finish with build().

Type Parameters​

T​

T extends ModelDefs

Methods​

addSchemaUpdate()​

addSchemaUpdate<S>(update): SchemaVersionBuilder<T & S>

Defined in: defineSchemaUpdate.ts:103

Apply a named change from defineSchemaUpdate to this version.

Type Parameters​

S​

S extends ModelDefs

Parameters​

update​

SchemaUpdate<T, S>

Returns​

SchemaVersionBuilder<T & S>

build()​

build(): VersionedSchema<T>

Defined in: defineSchemaUpdate.ts:109

Produce the finished VersionedSchema.

Returns​

VersionedSchema<T>

withMigrations()​

withMigrations(migrations): SchemaVersionBuilder<T>

Defined in: defineSchemaUpdate.ts:107

Attach explicit field migrations, supplementing the derivedFrom sugar on addField.

Parameters​

migrations​

VersionMigrations

Returns​

SchemaVersionBuilder<T>