API Reference

hashKey

function hashKey(queryKey: readonly unknown[]): string;

function hashKey(queryKey: readonly unknown[]): string;

Defined in: packages/query-core/src/utils.ts:323

Default query & mutation keys hash function. Hashes the value into a stable hash.

Parameters

queryKey

readonly unknown[]

The query or mutation key to hash.

Returns

string

The stable hash of the key, as a JSON string.

Example

// Object keys are sorted, so key order doesn't affect the hash:
hashKey(['todos', { page: 1, filter: 'done' }]) // === '["todos",{"filter":"done","page":1}]'

// Object keys are sorted, so key order doesn't affect the hash:
hashKey(['todos', { page: 1, filter: 'done' }]) // === '["todos",{"filter":"done","page":1}]'

Edit on GitHub

PreviousFunctions / experimental_streamedQuery

NextFunctions / hydrate

Blog

@Tan_Stack on X.com

@TannerLinsley on X.com

GitHub

YouTube

Nozzle.io - Keyword Rank Tracker

Ethos

Tenets

hashKey

Parameters

queryKey

Returns

Example

Want to Skip the Docs?