SpecializedColDefFn

SpecializedColDefFn<TColumnType, TAllowsCustomSchema, TBaseDecoded>: () => object<TDecoded, TNullable, TDefault, TPrimaryKey>(args) => object

Defined in: packages/@livestore/common/dist/schema/state/sqlite/db-schema/dsl/field-defs.d.ts:57

Type Parameters

• TColumnType extends FieldColumnType

• TAllowsCustomSchema extends boolean

• TBaseDecoded

Returns

object

columnType

columnType: TColumnType

default

default: Option.None<never>

nullable

nullable: false

primaryKey

primaryKey: false

schema

schema: Schema<TBaseDecoded, DefaultEncodedForColumnType<TColumnType>>

Type Parameters

• TDecoded = TBaseDecoded

• TNullable extends boolean = false

• TDefault = typeof NoDefault

• TPrimaryKey extends boolean = false

Parameters

args

TAllowsCustomSchema extends true ? object : object

Returns

object

columnType

columnType: TColumnType

default

default: TDefault extends NoDefault ? Option.None<never> : Option.Some<TDefault>

nullable

nullable: NoInfer<TNullable>

primaryKey

primaryKey: NoInfer<TPrimaryKey>

schema

schema: TNullable extends true ? Schema<NoInfer<TDecoded> | null, DefaultEncodedForColumnType<TColumnType> | null> : Schema<NoInfer<TDecoded>, DefaultEncodedForColumnType<TColumnType>>