Skip to content

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

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

description

Optional description: string

See SyncTableOptions.description

Inherited from

SyncTableDef.description

Defined in

api.ts:160


entityName

Optional entityName: string

See DynamicOptions.entityName

Inherited from

SyncTableDef.entityName

Defined in

api.ts:168


getDisplayUrl

getDisplayUrl: MetadataFormula

See DynamicSyncTableOptions.getDisplayUrl

Defined in

api.ts:188


getName

getName: MetadataFormula

See DynamicSyncTableOptions.getName

Defined in

api.ts:186


getSchema

getSchema: MetadataFormula

See DynamicSyncTableOptions.getSchema

Overrides

SyncTableDef.getSchema

Defined in

api.ts:184


getter

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

See SyncTableOptions.formula

Inherited from

SyncTableDef.getter

Defined in

api.ts:164


isDynamic

isDynamic: true

Identifies this sync table as dynamic.

Defined in

api.ts:182


listDynamicUrls

Optional listDynamicUrls: MetadataFormula

See DynamicSyncTableOptions.listDynamicUrls

Defined in

api.ts:190


name

name: string

See SyncTableOptions.name

Inherited from

SyncTableDef.name

Defined in

api.ts:158


schema

schema: SchemaT

See SyncTableOptions.schema

Inherited from

SyncTableDef.schema

Defined in

api.ts:162