Kysoql
ReferenceAPI referenceInterfaces

GeolocationFunctionModule

Generated API reference for GeolocationFunctionModule in @kysoql/core.

@kysoql/core / GeolocationFunctionModule

Geolocation expression helpers exposed to SELECT and ORDER BY callbacks.

Extended by

Type Parameters

Type Parameter
DB
TB extends keyof DB

Methods

geolocation()

geolocation(latitude, longitude): GeolocationFunctionBuilder;

Builds a Salesforce GEOLOCATION(latitude, longitude) expression.

Parameters

ParameterType
latitudenumber
longitudenumber

Returns

GeolocationFunctionBuilder


distance()

Call Signature

distance<First>(
   location,
   destination,
   unit
): DistanceFunctionBuilder<DistanceLiteralOutput<DB, TB, First>, ReferenceFilterable<DB, TB, First>, ReferenceSortable<DB, TB, First>>;

Builds a typed Salesforce DISTANCE(...) expression.

Type Parameters
Type Parameter
First extends string
Parameters
ParameterType
locationFirst & LocationFieldReference<DB, TB, First>
destinationGeolocationFunctionBuilder
unitDistanceUnit
Returns

DistanceFunctionBuilder<DistanceLiteralOutput<DB, TB, First>, ReferenceFilterable<DB, TB, First>, ReferenceSortable<DB, TB, First>>

Call Signature

distance<First, Second>(
   location,
   destination,
   unit
): DistanceFunctionBuilder<DistanceFieldOutput<DB, TB, First, Second>, BothTrue<ReferenceFilterable<DB, TB, First>, ReferenceFilterable<DB, TB, Second>>, BothTrue<ReferenceSortable<DB, TB, First>, ReferenceSortable<DB, TB, Second>>>;

Builds a typed Salesforce DISTANCE(...) expression.

Type Parameters
Type Parameter
First extends string
Second extends string
Parameters
ParameterType
locationFirst & LocationFieldReference<DB, TB, First>
destinationSecond & LocationFieldReference<DB, TB, Second>
unitDistanceUnit
Returns

DistanceFunctionBuilder<DistanceFieldOutput<DB, TB, First, Second>, BothTrue<ReferenceFilterable<DB, TB, First>, ReferenceFilterable<DB, TB, Second>>, BothTrue<ReferenceSortable<DB, TB, First>, ReferenceSortable<DB, TB, Second>>>

On this page