KysoqlExpressionBuilder
Generated API reference for ExpressionBuilder in @kysoql/core.
@kysoql/core / ExpressionBuilder
Expression helper passed to typed WHERE callbacks.
Type Parameters
| Type Parameter | Default type |
|---|---|
DB | - |
TB extends keyof DB | - |
AllowSemiJoin extends boolean | true |
Call Signature
ExpressionBuilder<Output, Sortable>(
lhs,
op,
rhs
): ExpressionWrapper<DB, TB, false>;Builds a typed WHERE comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
Output |
Sortable extends boolean |
Parameters
| Parameter | Type |
|---|---|
lhs | DistanceFunctionExpression<Output, true, Sortable> |
op | DistanceComparisonOperator |
rhs | number |
Returns
ExpressionWrapper<DB, TB, false>
Call Signature
ExpressionBuilder<Output, Value, AllowedOperator, Operator, Identity, Right>(
lhs,
op,
rhs
): ExpressionWrapper<DB, TB, false>;Builds a typed WHERE comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
Output |
Value |
AllowedOperator extends ComparisonOperator |
Operator extends ComparisonOperator |
Identity extends string |
Right |
Parameters
| Parameter | Type |
|---|---|
lhs | DateFunctionExpression<Output, Value, AllowedOperator, Identity> |
op | Operator |
rhs | Right |
Returns
ExpressionWrapper<DB, TB, false>
Call Signature
ExpressionBuilder<Reference, Operator, Right>(
lhs,
op,
rhs
): ExpressionWrapper<DB, TB, false>;Builds a typed WHERE comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
Reference extends string |
Operator extends "=" | "!=" | "like" |
Right extends string | SoqlLikeLiteral | null |
Parameters
| Parameter | Type |
|---|---|
lhs | ToLabelFilterFunctionExpression<Reference> |
op | Operator |
rhs | Right |
Returns
ExpressionWrapper<DB, TB, false>
Call Signature
ExpressionBuilder<Value, Operator>(
lhs,
op,
rhs
): ExpressionWrapper<DB, TB, false>;Builds a typed WHERE comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
Value |
Operator extends FormulaFilterComparisonOperator |
Parameters
| Parameter | Type |
|---|---|
lhs | FormulaFilterFunctionExpression<Value> |
op | Operator |
rhs | Value |
Returns
ExpressionWrapper<DB, TB, false>
Call Signature
ExpressionBuilder<RE, OP, RHS>(
lhs,
op,
rhs
): ExpressionWrapper<DB, TB, SemiJoinFlag<RHS>>;Builds a typed WHERE comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
RE extends string |
OP extends | "=" | "!=" | OrderedComparisonOperator | "in" | "not in" | MultiSelectComparisonOperator | "like" |
RHS |
Parameters
| Parameter | Type |
|---|---|
lhs | RE & FilterableFieldName<DB, TB, RE> |
op | OP |
rhs | RHS |
Returns
ExpressionWrapper<DB, TB, SemiJoinFlag<RHS>>
Methods
and()
and<Expressions>(expressions): ExpressionWrapper<DB, TB, CombinedSemiJoinFlag<Expressions>>;Combines two or more expressions with boolean AND.
Type Parameters
| Type Parameter |
|---|
Expressions extends readonly [ExpressionWrapper<DB, TB, boolean>, ExpressionWrapper<DB, TB, boolean>, ExpressionWrapper<DB, TB, boolean>] |
Parameters
| Parameter | Type |
|---|---|
expressions | Expressions |
Returns
ExpressionWrapper<DB, TB, CombinedSemiJoinFlag<Expressions>>
not()
not(expression): ExpressionWrapper<DB, TB, false>;Negates an expression with boolean NOT.
Parameters
| Parameter | Type |
|---|---|
expression | ExpressionWrapper<DB, TB, false> |
Returns
ExpressionWrapper<DB, TB, false>
or()
or(expressions): ExpressionWrapper<DB, TB, false>;Combines two or more expressions with boolean OR.
Parameters
| Parameter | Type |
|---|---|
expressions | readonly [ExpressionWrapper<DB, TB, false>, ExpressionWrapper<DB, TB, false>, ExpressionWrapper<DB, TB, false>] |
Returns
ExpressionWrapper<DB, TB, false>
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
beta | readonly | BetaExpressionModule<DB, TB> | Opt-in helpers for beta SOQL expression features. |
fn | readonly | FilterFunctionModule<DB, TB> | Function helpers available in this expression context. |