Skip to content

Interface: SyncTableDef<K, L, ParamDefsT, SchemaT>

core.SyncTableDef

The result of defining a sync table. Should not be necessary to use directly, instead, define sync tables using makeSyncTable.

Type parameters

Name Type
K extends string
L extends string
ParamDefsT extends ParamDefs
SchemaT extends ObjectSchema<K, L>

Hierarchy

  • SyncTableDef

DynamicSyncTableDef

Properties

defaultAddDynamicColumns

Optional defaultAddDynamicColumns: boolean

See defaultAddDynamicColumns

Defined in

api.ts:232


description

Optional description: string

See description

Defined in

api.ts:215


entityName

Optional entityName: string

See entityName

Defined in

api.ts:230


getSchema

Optional getSchema: MetadataFormula

See getSchema

Defined in

api.ts:228


getter

getter: SyncFormula<K, L, ParamDefsT, SchemaT>

See formula

Defined in

api.ts:226


identityName

identityName: string

The identityName is persisted for all sync tables so that a dynamic schema can be annotated with an identity automatically.

See identityName for more details.

Defined in

api.ts:224


name

name: string

See name

Defined in

api.ts:213


schema

schema: SchemaT

See schema

Defined in

api.ts:217