Class CaseBuilder<DB, TB, W, O>

Type Parameters

  • DB
  • TB extends keyof DB
  • W = unknown
  • O = never

Implements

Constructors

constructor

Properties

#private

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>

Properties

Private #private

#private: any

Methods

when

  • when<RE, VE>(lhs, op, rhs): CaseThenBuilder<DB, TB, W, O>

  • Adds a when clause to the case statement.

    A when call 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

    Returns CaseThenBuilder<DB, TB, W, O>

  • when(expression): CaseThenBuilder<DB, TB, W, O>

  • Parameters

    Returns CaseThenBuilder<DB, TB, W, O>

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

Settings

Member Visibility

Theme

On This Page

constructor#privatewhen