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:282

description¶

• Optional description: string

See description

Defined in¶

api.ts:265

entityName¶

• Optional entityName: string

See entityName

Defined in¶

api.ts:280

getSchema¶

• Optional getSchema: MetadataFormula

See getSchema

Defined in¶

api.ts:278

getter¶

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

See formula

Defined in¶

api.ts:276

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:274

name¶

• name: string

See name

Defined in¶

api.ts:263

schema¶

• schema: SchemaT

See schema

Defined in¶

api.ts:267