routier-collection

---

routier-collection / core/src / JsonTranslator

Class: JsonTranslator<TRoot, TShape>

Defined in: core/src/plugins/translators/JsonTranslator.ts:11

Extends

• DataTranslator<TRoot, TShape>

Type Parameters

TRoot

TRoot extends object

TShape

TShape

Constructors

Constructor

new JsonTranslator<TRoot, TShape>(query, innerSide?): JsonTranslator<TRoot, TShape>

Defined in: core/src/plugins/translators/JsonTranslator.ts:20

Parameters

query

IQuery<TRoot, TShape>

innerSide?

JoinInnerSide

The inner collection's rows, when this query carries a join option. A plugin that omits it for a query that HAS a join gets a throw from join() rather than a silently un-joined result.

Returns

JsonTranslator<TRoot, TShape>

Overrides

DataTranslator.constructor

Methods

translate()

translate(data): ITranslatedValue<TShape>

Defined in: core/src/plugins/translators/DataTranslator.ts:75

Parameters

data

unknown

Returns

ITranslatedValue<TShape>

Inherited from

DataTranslator.translate

---

join()

join<TResult>(data, option): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:33

The hash join itself, over rows already in memory — the floor every non-SQL backend stands on.

Both halves are deserialized here, each with its own schema, because that is where the === on key values is specified to happen: in entity shape, by the property names the caller wrote in the key selectors. A from-renamed column reads correctly for free.

Type Parameters

TResult

TResult

Parameters

data

unknown

option

QueryOption<TShape, "join">

Returns

TResult

Overrides

DataTranslator.join

---

filter()

filter<TResult>(data, option): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:56

Type Parameters

TResult

TResult

Parameters

data

unknown

option

QueryOption<TShape, "filter">

Returns

TResult

Overrides

DataTranslator.filter

---

map()

map<T>(data, option): T

Defined in: core/src/plugins/translators/JsonTranslator.ts:75

Type Parameters

T

T

Parameters

data

unknown

option

QueryOption<T, "map">

Returns

T

Overrides

DataTranslator.map

---

group()

group<T>(data, option): T

Defined in: core/src/plugins/translators/JsonTranslator.ts:103

Type Parameters

T

T

Parameters

data

unknown

option

QueryOption<T, "group">

Returns

T

Overrides

DataTranslator.group

---

count()

count<TResult>(data, _): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:145

Type Parameters

TResult

TResult extends number

Parameters

data

unknown

_

QueryOption<TShape, "count">

Returns

TResult

Overrides

DataTranslator.count

---

min()

min<TResult>(data, _): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:158

Type Parameters

TResult

TResult extends string | number | Date

Parameters

data

unknown

_

QueryOption<TShape, "min">

Returns

TResult

Overrides

DataTranslator.min

---

max()

max<TResult>(data, _): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:176

Type Parameters

TResult

TResult extends string | number | Date

Parameters

data

unknown

_

QueryOption<TShape, "max">

Returns

TResult

Overrides

DataTranslator.max

---

sort()

sort<TResult>(data, option): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:194

Type Parameters

TResult

TResult

Parameters

data

unknown

option

QueryOption<TShape, "sort">

Returns

TResult

Overrides

DataTranslator.sort

---

nearest()

nearest<TResult>(data, option): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:232

The similarity search itself, over values already in memory.

This is the floor the whole feature stands on: it is reached whenever the backend did not do the search, which is every backend except the ones with a native vector index. It reads the property through the option's selector, so it works on any shape the rows arrive in.

Type Parameters

TResult

TResult

Parameters

data

unknown

option

QueryOption<TShape, "nearest">

Returns

TResult

Overrides

DataTranslator.nearest

---

sum()

sum<TResult>(data, _): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:243

Type Parameters

TResult

TResult extends number

Parameters

data

unknown

_

QueryOption<TShape, "sum">

Returns

TResult

Overrides

DataTranslator.sum

---

distinct()

distinct<TResult>(data, _): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:269

Type Parameters

TResult

TResult

Parameters

data

unknown

_

QueryOption<TShape, "distinct">

Returns

TResult

Overrides

DataTranslator.distinct

---

skip()

skip<TResult>(data, option): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:301

Type Parameters

TResult

TResult

Parameters

data

unknown

option

QueryOption<TShape, "skip">

Returns

TResult

Overrides

DataTranslator.skip

---

take()

take<TResult>(data, option): TResult

Defined in: core/src/plugins/translators/JsonTranslator.ts:321

Type Parameters

TResult

TResult

Parameters

data

unknown

option

QueryOption<TShape, "take">

Returns

TResult

Overrides

DataTranslator.take