Skip to content

API reference > @kontsedal/olas-core > defineQuery

defineQuery() function โ€‹

Define a shared query, cached per root and named by its id. Spec ยง5.2.

Signature:

typescript
export declare function defineQuery<Args extends unknown[], T>(spec: QuerySpec<Args, T>): Query<Args, T>;

Parameters โ€‹

Parameter

Type

Description

spec

QuerySpec<Args, T>

Returns:

Query<Args, T>

Example โ€‹

ts
export const userQuery = defineQuery({
  id: 'users/detail',
  key: (id: string) => [id],
  fetcher: ({ signal, deps }, id) => deps.api.getUser(id, { signal }),
  staleTime: 30_000,
})

Released under the MIT License.