Skip to main content

Variable: nodeKeys

const nodeKeys: object

Defined in: web/lib/hooks/use-nodes.ts:138

Query key factory for node queries.

Type declaration​

all​

all: readonly ["nodes"]

Base key

byKind()​

byKind: (kind, params?) => readonly ["nodes", "kind", NodeKind, undefined | NodeListParams]

Key for nodes by kind

Parameters​

kind​

NodeKind

params?​

NodeListParams

Returns​

readonly ["nodes", "kind", NodeKind, undefined | NodeListParams]

bySubkind()​

bySubkind: (subkind, params?) => readonly ["nodes", "subkind", string, undefined | NodeListParams]

Key for nodes by subkind

Parameters​

subkind​

string

params?​

NodeListParams

Returns​

readonly ["nodes", "subkind", string, undefined | NodeListParams]

detail()​

detail: (uri) => readonly ["nodes", "detail", string]

Key for single node

Parameters​

uri​

string

Returns​

readonly ["nodes", "detail", string]

hierarchy()​

hierarchy: (subkind) => readonly ["nodes", "hierarchy", string]

Key for hierarchy (field tree, etc.)

Parameters​

subkind​

string

Returns​

readonly ["nodes", "hierarchy", string]

search: (query, params?) => readonly ["nodes", "search", string, undefined | NodeSearchParams]

Key for search queries

Parameters​

query​

string

params?​

NodeSearchParams

Returns​

readonly ["nodes", "search", string, undefined | NodeSearchParams]