Interface: RelatedQuery<Entry, TableInfo, Paginated, OrderProperty>

server.RelatedQuery An immutable, lazy relation selection. The native reader owns membership, supported index orderings, access and exact continuation.

​

Type parameters

​

Methods

​

filter

▸ filter(predicate): NavigationResult<Entry, Paginated, TableInfo, OrderProperty>

​

Parameters

​

Returns

NavigationResult<Entry, Paginated, TableInfo, OrderProperty>

---

​

orderBy

▸ orderBy(property, direction?): NavigationResult<Entry, Paginated, TableInfo, OrderProperty>

​

Parameters

​

Returns

NavigationResult<Entry, Paginated, TableInfo, OrderProperty>

---

​

has

▸ has(targetId): Promise<boolean> Prove membership through a point or pair lookup, including retained IDs.

​

Parameters

​

Returns

Promise<boolean>

---

​

unique

▸ unique(): Promise<null | Entry> Refuse if more than one identity is related, including unavailable ones.

​

Returns

Promise<null | Entry>

---

​

take

▸ take(n): Promise<Entry[]> Read a prefix of at most 10000 entries.

​

Parameters

​

Returns

Promise<Entry[]>

---

​

collect

▸ collect(): Promise<Entry[]> Read the complete set or fail if the read exceeds its budget.

​

Returns

Promise<Entry[]>

---

​

paginate

▸ paginate(options): Promise<RelatedPage<Entry>> Query-only. Continue the same basis with an opaque cursor.

​

Parameters

​

Returns

Promise<RelatedPage<Entry>>