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

Defined in: api.ts:352

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

Extended by

• DynamicSyncTableDef

Type Parameters

Type Parameter
K extends string
L extends string
ParamDefsT extends ParamDefs
SchemaT extends ObjectSchema<K, L>
ContextT extends SyncExecutionContext<any, any>
PermissionsContextT extends SyncPassthroughData

Properties

defaultAddDynamicColumns?

optional defaultAddDynamicColumns: boolean

Defined in: api.ts:384

See DynamicOptions.defaultAddDynamicColumns

---

description?

optional description: string

Defined in: api.ts:367

See SyncTableOptions.description

---

displayName?

optional displayName: string

Defined in: api.ts:364

See SyncTableOptions.displayName

---

entityName?

optional entityName: string

Defined in: api.ts:382

See DynamicOptions.entityName

---

getSchema?

optional getSchema: MetadataFormula<ExecutionContext, LegacyDefaultMetadataReturnType>

Defined in: api.ts:380

See DynamicOptions.getSchema

---

getter

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

Defined in: api.ts:378

See SyncTableOptions.formula

---

identityName

identityName: string

Defined in: api.ts:376

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

See SyncTableOptions.identityName for more details.

---

name

name: string

Defined in: api.ts:361

See SyncTableOptions.name

---

schema

schema: SchemaT

Defined in: api.ts:369

See SyncTableOptions.schema