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
Section titled “Type Parameters”TColumnType
Section titled “TColumnType”TColumnType extends FieldColumnType
TAllowsCustomSchema
Section titled “TAllowsCustomSchema”TAllowsCustomSchema extends boolean
TBaseDecoded
Section titled “TBaseDecoded”TBaseDecoded
Call Signature
Section titled “Call Signature”():
object
Returns
Section titled “Returns”object
columnType
Section titled “columnType”columnType:
TColumnType
default
Section titled “default”default:
Option.None<never>
nullable
Section titled “nullable”nullable:
false
primaryKey
Section titled “primaryKey”primaryKey:
false
schema
Section titled “schema”schema:
Schema<TBaseDecoded,DefaultEncodedForColumnType<TColumnType>>
Call Signature
Section titled “Call Signature”<
TDecoded,TNullable,TDefault,TPrimaryKey>(args):object
Type Parameters
Section titled “Type Parameters”TDecoded
Section titled “TDecoded”TDecoded = TBaseDecoded
TNullable
Section titled “TNullable”TNullable extends boolean = false
TDefault
Section titled “TDefault”TDefault = typeof NoDefault
TPrimaryKey
Section titled “TPrimaryKey”TPrimaryKey extends boolean = false
Parameters
Section titled “Parameters”TAllowsCustomSchema extends true ? object : object
Returns
Section titled “Returns”object
columnType
Section titled “columnType”columnType:
TColumnType
default
Section titled “default”default:
TDefaultextendsNoDefault?Option.None<never> :Option.Some<TDefault>
nullable
Section titled “nullable”nullable:
NoInfer<TNullable>
primaryKey
Section titled “primaryKey”primaryKey:
NoInfer<TPrimaryKey>
schema
Section titled “schema”schema:
TNullableextendstrue?Schema<NoInfer<TDecoded> |null,DefaultEncodedForColumnType<TColumnType> |null> :Schema<NoInfer<TDecoded>,DefaultEncodedForColumnType<TColumnType>>