Interface: RelationIndexRange<Doc, Fields, Steps>

server.RelationIndexRange Builds the index range of withIndex with the ordinary index-range rules: equalities on the index’s fields in index order, then an optional lower bound and an optional upper bound on the next field. Values are literals or declared arguments (q.arg).

​

Type parameters

​

Hierarchy

• RelationIndexRangeEnd<Steps> ↳ RelationIndexRange

​

Properties

​

[rangeSteps]

• Readonly [rangeSteps]: Steps

​

Inherited from

RelationIndexRangeEnd.[rangeSteps]

​

Methods

​

eq

▸ eq<V>(field, value): RelationIndexRange<Doc, Tail<Fields> & readonly string[], […Steps, { type: "Eq" ; field: First<Fields> ; value: V }]>

​

Type parameters

​

Parameters

​

Returns

RelationIndexRange<Doc, Tail<Fields> & readonly string[], […Steps, { type: "Eq" ; field: First<Fields> ; value: V }]>

---

​

gt

▸ gt<V>(field, value): RelationIndexUpperBound<Doc, First<Fields>, […Steps, { type: "Gt" ; field: First<Fields> ; value: V }]>

​

Type parameters

​

Parameters

​

Returns

RelationIndexUpperBound<Doc, First<Fields>, […Steps, { type: "Gt" ; field: First<Fields> ; value: V }]>

---

​

gte

▸ gte<V>(field, value): RelationIndexUpperBound<Doc, First<Fields>, […Steps, { type: "Gte" ; field: First<Fields> ; value: V }]>

​

Type parameters

​

Parameters

​

Returns

RelationIndexUpperBound<Doc, First<Fields>, […Steps, { type: "Gte" ; field: First<Fields> ; value: V }]>

---

​

lt

▸ lt<V>(field, value): RelationIndexRangeEnd<[…Steps, { type: "Lt" ; field: First<Fields> ; value: V }]>

​

Type parameters

​

Parameters

​

Returns

RelationIndexRangeEnd<[…Steps, { type: "Lt" ; field: First<Fields> ; value: V }]>

---

​

lte

▸ lte<V>(field, value): RelationIndexRangeEnd<[…Steps, { type: "Lte" ; field: First<Fields> ; value: V }]>

​

Type parameters

​

Parameters

​

Returns

RelationIndexRangeEnd<[…Steps, { type: "Lte" ; field: First<Fields> ; value: V }]>