ColDefFn

ColDefFn<TColumnType>: () => object<TEncoded, TDecoded, TNullable, TDefault, TPrimaryKey>(args) => object

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

Type Parameters

• TColumnType extends FieldColumnType

Returns

object

columnType

columnType: TColumnType

default

default: Option.None<never>

nullable

nullable: false

primaryKey

primaryKey: false

schema

schema: Schema<DefaultEncodedForColumnType<TColumnType>>

Type Parameters

• TEncoded extends string | number | Uint8Array<ArrayBufferLike>

• TDecoded = DefaultEncodedForColumnType<TColumnType>

• TNullable extends boolean = false

• TDefault = typeof NoDefault

• TPrimaryKey extends boolean = false

Parameters

args

default?

TDefault

nullable?

TNullable

primaryKey?

TPrimaryKey

schema?

Schema<TDecoded, TEncoded>

Returns

object

columnType

columnType: TColumnType

default

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

nullable

nullable: NoInfer<TNullable>

primaryKey

primaryKey: NoInfer<TPrimaryKey>

schema

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