Class CaseBuilder<DB, TB, W, O>

Type Parameters

DB
TB extends keyof DB
W = unknown
O = never

Hierarchy

CaseBuilder

Implements

Whenable<DB, TB, W, O>

Index

Constructors

constructor

Methods

when

Constructors

constructor

new CaseBuilder<DB, TB, W, O>(props): 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>
- Defined in kysely/src/query-builder/case-builder.ts:25

Methods

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:29
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:40
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:42

Class CaseBuilder<DB, TB, W, O>

Type Parameters

DB

TB extends keyof DB

W = unknown

O = never

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

DB

TB extends string | number | symbol

W = unknown

O = never

Parameters

props: CaseBuilderProps

Returns CaseBuilder<DB, TB, W, O>

Methods

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