Skip to main content

Variable: fieldKeys

const fieldKeys: object

Defined in: web/lib/hooks/use-field.ts:23

Query key factory for field-related queries.

Type declaration​

all​

all: readonly ["fields"]

Base key for all field queries

ancestors()​

ancestors: (id) => readonly ["fields", "detail", string, "ancestors"]

Key for field ancestors queries

Parameters​

id​

string

Returns​

readonly ["fields", "detail", string, "ancestors"]

children()​

children: (id) => readonly ["fields", "detail", string, "children"]

Key for field children queries

Parameters​

id​

string

Returns​

readonly ["fields", "detail", string, "children"]

detail()​

detail: (id) => readonly ["fields", "detail", string]

Key for specific field detail query

Parameters​

id​

string

Returns​

readonly ["fields", "detail", string]

details()​

details: () => readonly ["fields", "detail"]

Key for field detail queries

Returns​

readonly ["fields", "detail"]

list()​

list: (params) => readonly ["fields", "list", { limit: number; parentId: string; status: string; }]

Key for specific field list query with params

Parameters​

params​
limit​

number

parentId​

string

status​

string

Returns​

readonly ["fields", "list", { limit: number; parentId: string; status: string; }]

lists()​

lists: () => readonly ["fields", "list"]

Key for field list queries

Returns​

readonly ["fields", "list"]

preprints()​

preprints: (id) => readonly ["fields", "detail", string, "preprints"]

Key for field preprints queries

Parameters​

id​

string

Returns​

readonly ["fields", "detail", string, "preprints"]

Remarks​

Follows TanStack Query best practices for cache key management. Enables fine-grained cache invalidation for field data.

Example​

// Invalidate all field queries
queryClient.invalidateQueries({ queryKey: fieldKeys.all });

// Invalidate specific field
queryClient.invalidateQueries({ queryKey: fieldKeys.detail('field-id') });