Skip to main content
Version: v10.0.0

ResourceListOptions


Import
import { ResourceListOptions } from "@hyper-fetch/db"

Preview​

type ResourceListOptions<Row,Node,Mapped,Filters,Cursor> = {
cursor?: (response: ExtractResponseType<ListRequest<Node>>) => Cursor | null | undefined;
page?: (cursor: Cursor) => RequestPatch<ListRequest<Node>>;
rows?: (response: ExtractResponseType<ListRequest<Node>>) => readonly Mapped[];
where?: readonly (Filters & ResourceQueryFilters<Row, Node>)[];
}

Structure​

ResourceListOptions
NameTypeDescription
where
readonly (Filters & ResourceQueryFilters<Row, Node>)[]

Query params sent as eq filters. Only query params that are row fields of the same name are offered.

cursor
(response: ExtractResponseType<ListRequest<Node>>) => Cursor | null | undefined

Reads the next page's cursor, which makes the list paginated

page
(cursor: Cursor) => RequestPatch<ListRequest<Node>>

Sends a cursor to load the page after it

rows
(response: ExtractResponseType<ListRequest<Node>>) => readonly Mapped[]

Reads complete rows from the list response