Skip to content

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

core.DynamicSyncTableDef

Type definition for a Dynamic Sync Table. Should not be necessary to use directly, instead, define dynamic sync tables using makeDynamicSyncTable.

Type parameters

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

Hierarchy

DynamicSyncTableDef

Properties

defaultAddDynamicColumns

Optional defaultAddDynamicColumns: boolean

See defaultAddDynamicColumns

Inherited from

SyncTableDef.defaultAddDynamicColumns

Defined in

api.ts:213


description

Optional description: string

See description

Inherited from

SyncTableDef.description

Defined in

api.ts:196


entityName

Optional entityName: string

See entityName

Inherited from

SyncTableDef.entityName

Defined in

api.ts:211


getDisplayUrl

getDisplayUrl: MetadataFormula

See getDisplayUrl

Defined in

api.ts:233


getName

getName: MetadataFormula

See getName

Defined in

api.ts:231


getSchema

getSchema: MetadataFormula

See getSchema

Overrides

SyncTableDef.getSchema

Defined in

api.ts:229


getter

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

See formula

Inherited from

SyncTableDef.getter

Defined in

api.ts:207


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.

Inherited from

SyncTableDef.identityName

Defined in

api.ts:205


isDynamic

isDynamic: true

Identifies this sync table as dynamic.

Defined in

api.ts:227


listDynamicUrls

Optional listDynamicUrls: MetadataFormula

See listDynamicUrls

Defined in

api.ts:235


name

name: string

See name

Inherited from

SyncTableDef.name

Defined in

api.ts:194


schema

schema: SchemaT

See schema

Inherited from

SyncTableDef.schema

Defined in

api.ts:198