TypeScript Utils by Ian Macalinao
    Preparing search index...

    Interface KyselyUtils<DB, TMapping>

    Generates utilities for a Kysely database.

    Note that this cannot be tree-shaken. This should not matter since this is run server-side.

    interface KyselyUtils<DB, TMapping extends PrefixMapping = PrefixMapping> {
        createUpdate: <TB extends string | number | symbol>(
            updates: (undefined | null | false | UpdateObject<DB, TB>)[],
        ) => UpdateObject<DB, TB>;
        createUpdateFn: <TB extends string | number | symbol, T>(
            updates: {
                [K in string | number | symbol]: UpdateFieldExpression<DB, TB, T, K>
            },
        ) => (data: Partial<T>) => UpdateObject<DB, TB>;
        defaultEb: ExpressionBuilder<DB, never>;
        publicToRawId: <TTable extends string>(
            table: TTable,
            id: ExpressionArg<`${TMapping[TTable]}_${string}`>,
        ) => AliasableExpression<string>;
        publicToRawIdNullable: <TTable extends string>(
            table: TTable,
            id: ExpressionArg<null | `${TMapping[TTable]}_${string}`>,
        ) => AliasableExpression<null | string>;
        rawToPublicId: <TTable extends string>(
            table: TTable,
            id: ExpressionArg<string>,
        ) => AliasableExpression<`${TMapping[TTable]}_${string}`>;
        rawToPublicIdNullable: <TTable extends string>(
            table: TTable,
            id: ExpressionArg<null | string>,
        ) => AliasableExpression<null | `${TMapping[TTable]}_${string}`>;
        zId: IDSchemas<TMapping>;
    }

    Type Parameters

    • DB
    • TMapping extends PrefixMapping = PrefixMapping

    Hierarchy (View Summary)

    Index

    Properties

    createUpdate: <TB extends string | number | symbol>(
        updates: (undefined | null | false | UpdateObject<DB, TB>)[],
    ) => UpdateObject<DB, TB>
    createUpdateFn: <TB extends string | number | symbol, T>(
        updates: {
            [K in string | number | symbol]: UpdateFieldExpression<DB, TB, T, K>
        },
    ) => (data: Partial<T>) => UpdateObject<DB, TB>
    defaultEb: ExpressionBuilder<DB, never>
    publicToRawId: <TTable extends string>(
        table: TTable,
        id: ExpressionArg<`${TMapping[TTable]}_${string}`>,
    ) => AliasableExpression<string>
    publicToRawIdNullable: <TTable extends string>(
        table: TTable,
        id: ExpressionArg<null | `${TMapping[TTable]}_${string}`>,
    ) => AliasableExpression<null | string>
    rawToPublicId: <TTable extends string>(
        table: TTable,
        id: ExpressionArg<string>,
    ) => AliasableExpression<`${TMapping[TTable]}_${string}`>
    rawToPublicIdNullable: <TTable extends string>(
        table: TTable,
        id: ExpressionArg<null | string>,
    ) => AliasableExpression<null | `${TMapping[TTable]}_${string}`>
    zId: IDSchemas<TMapping>