Last Updated: 3/10/2026
- CaseBuilder
Class CaseBuilder
Type Parameters
- DB
- TB extends keyof DB
- W = unknown
- O = never
Implements
Index
Constructors
Methods
Constructors
constructor
-
new CaseBuilder<DB, TB extends string | number | symbol, W = unknown, O = never>(
props: CaseBuilderProps,
): CaseBuilder<DB, TB, W, O>Type Parameters
- DB
- TB extends string | number | symbol
- W = unknown
- O = never
Parameters
- props: CaseBuilderProps
Returns CaseBuilder<DB, TB, W, O>
Methods
when
-
when<
RE extends
| string
| Expression<any>
| DynamicReferenceBuilder<any>
| SelectQueryBuilderExpression<Record<string, any>>
| OperandExpressionFactory<DB, TB, any>,
VE extends any,(
lhs: unknown extends W
? RE
: KyselyTypeError<
“when(lhs, op, rhs) is not supported when using case(value)”,
>,
op: ComparisonOperatorExpression,
rhs: VE,
): CaseThenBuilder<DB, TB, W, O>Adds a
whenclause to the case statement.A
whencall must be followed by a CaseThenBuilder.then call.Type Parameters
- RE extends
| string
| Expression<any>
| DynamicReferenceBuilder<any>
| SelectQueryBuilderExpression<Record<string, any>>
| OperandExpressionFactory<DB, TB, any> - VE extends any
Parameters
- lhs: unknown extends W
? RE
: KyselyTypeError<
“when(lhs, op, rhs) is not supported when using case(value)”,
> - op: ComparisonOperatorExpression
- rhs: VE
Returns CaseThenBuilder<DB, TB, W, O>
- RE extends
-
when(expression: Expression<W>): CaseThenBuilder<DB, TB, W, O>
Parameters
- expression: Expression<W>
Returns CaseThenBuilder<DB, TB, W, O>
-
when(
value: unknown extends W
? KyselyTypeError<
“when(value) is only supported when using case(value)”,
>
: W,
): CaseThenBuilder<DB, TB, W, O>Parameters
- value: unknown extends W
? KyselyTypeError<
“when(value) is only supported when using case(value)”,
>
: W
Returns CaseThenBuilder<DB, TB, W, O>
- value: unknown extends W
Settings
Member Visibility
On This Page
Constructors
Methods