nullableIdColumn

nullableIdColumn<Brand>(codec): object

Defined in: src/adapters/kysely.ts:227

Kysely column adapter for a nullable Id<Brand> column.

Behaves like idColumn but fromDriver returns null for null / undefined driver values and toDriver passes null through unchanged. Use for optional foreign keys and LEFT JOIN results.

Type Parameters

Brand

Brand extends string

Parameters

codec

IdColumnCodec<Brand>

Returns

object

fromDriver()

fromDriver(value): Id<Brand> | null

Parameters

value

string | null

Returns

Id<Brand> | null

toDriver()

toDriver(value): string | null

Parameters

value

Id<Brand> | null | undefined

Returns

string | null

Example

import { nullableIdColumn } from "@smonn/ids/kysely";
import { createTimestampId } from "@smonn/ids";

const usr = createTimestampId("usr");
const authorCol = nullableIdColumn(usr);

// In a query result handler:
const authorId = authorCol.fromDriver(row.author_id); // Id<"usr"> | null