Class CaseWhenBuilder<DB, TB, W, O>

Type Parameters

DB
TB extends keyof DB
W
O

Hierarchy

CaseWhenBuilder

Implements

Whenable<DB, TB, W, O>
Endable<DB, TB, O | null>

Index

Constructors

constructor

Methods

else end endCase when

Constructors

constructor

new CaseWhenBuilder<DB, TB, W, O>(props): CaseWhenBuilder<DB, TB, W, O>
Type Parameters
- DB
- TB extends string | number | symbol
- W
- O
Parameters
- props: CaseBuilderProps
Returns CaseWhenBuilder<DB, TB, W, O>
- Defined in kysely/src/query-builder/case-builder.ts:100

Methods

else

else<E>(expression): CaseEndBuilder<DB, TB, O | ExtractTypeFromValueExpression<E>>
Adds an else clause to the case statement.

An else call must be followed by an Endable.end or Endable.endCase call.
Type Parameters
- E extends Expression<unknown>
Parameters
- expression: E
Returns CaseEndBuilder<DB, TB, O | ExtractTypeFromValueExpression<E>>
- Defined in kysely/src/query-builder/case-builder.ts:138
else<V>(value): CaseEndBuilder<DB, TB, O | V>
Type Parameters
- V
Parameters
- value: V
Returns CaseEndBuilder<DB, TB, O | V>
- Defined in kysely/src/query-builder/case-builder.ts:142

end

end(): ExpressionWrapper<DB, TB, null | O>
Returns ExpressionWrapper<DB, TB, null | O>
Implementation of Endable.end
- Defined in kysely/src/query-builder/case-builder.ts:155

endCase

endCase(): ExpressionWrapper<DB, TB, null | O>
Returns ExpressionWrapper<DB, TB, null | O>
Implementation of Endable.endCase
- Defined in kysely/src/query-builder/case-builder.ts:161

when

when<RE, VE>(lhs, op, rhs): CaseThenBuilder<DB, TB, W, O>
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>
Implementation of Whenable.when
- Defined in kysely/src/query-builder/case-builder.ts:104
when(expression): CaseThenBuilder<DB, TB, W, O>
Parameters
- expression: Expression<W>
Returns CaseThenBuilder<DB, TB, W, O>
Implementation of Whenable.when
- Defined in kysely/src/query-builder/case-builder.ts:115
when(value): 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>
Implementation of Whenable.when
- Defined in kysely/src/query-builder/case-builder.ts:117

Class CaseWhenBuilder<DB, TB, W, O>

Type Parameters

DB

TB extends keyof DB

W

O

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

DB

TB extends string | number | symbol

W

O

Parameters

props: CaseBuilderProps

Returns CaseWhenBuilder<DB, TB, W, O>

Methods

else

Type Parameters

E extends Expression<unknown>

Parameters

expression: E

Returns CaseEndBuilder<DB, TB, O | ExtractTypeFromValueExpression<E>>

Type Parameters

V

Parameters

value: V

Returns CaseEndBuilder<DB, TB, O | V>

end

Returns ExpressionWrapper<DB, TB, null | O>

endCase

Returns ExpressionWrapper<DB, TB, null | O>

when

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>

Parameters

expression: Expression<W>

Returns 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>

Settings

Member Visibility

Theme

On This Page

lhs: unknown extends W
? RE
: KyselyTypeError<"when(lhs, op, rhs) is not supported when using case(value)">

value: unknown extends W
? KyselyTypeError<"when(value) is only supported when using case(value)">
: W