KysoqlReferenceAPI referenceInterfaces
DistanceFunctionBuilder
Generated API reference for DistanceFunctionBuilder in @kysoql/core.
@kysoql/core / DistanceFunctionBuilder
Builder for Salesforce DISTANCE() expressions.
Extends
DistanceFunctionExpression<Output,Filterable,Sortable>
Type Parameters
| Type Parameter |
|---|
Output |
Filterable extends boolean |
Sortable extends boolean |
Methods
as()
as<Alias>(alias): AliasedDistanceFunctionBuilder<Output, Alias>;Aliases this expression for SELECT output and result mapping.
Type Parameters
| Type Parameter |
|---|
Alias extends string |
Parameters
| Parameter | Type |
|---|---|
alias | Alias |
Returns
AliasedDistanceFunctionBuilder<Output, Alias>
toOperationNode()
toOperationNode(): DistanceFunctionNode;Returns the immutable operation node represented by this expression.
Returns
Inherited from
DistanceFunctionExpression.toOperationNode
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
expressionType | readonly | Output | undefined | Type-only output marker used for fluent-query inference; implementations do not expose a meaningful runtime value. | DistanceFunctionExpression.expressionType |
[distanceFunctionCapabilitiesType] | readonly | object | Type-only marker used to preserve this expression capability through TypeScript inference. | DistanceFunctionExpression.[distanceFunctionCapabilitiesType] |
[distanceFunctionCapabilitiesType].filterable | readonly | Filterable | Whether this distance expression may be used in WHERE. | - |
[distanceFunctionCapabilitiesType].sortable | readonly | Sortable | Whether this distance expression may be used in ORDER BY. | - |