stringifyParams
Serializes Feathers params into a stable, deterministic string — built for generating cache keys.
Two normalizations make semantically-equal params produce the same string:
- sortObject: object keys are sorted recursively.
- sortArray: elements of query array operators (
$or,$and,$nor,$not,$in,$nin) are order-normalized.
Serialization is crash-safe and never throws on values that leak through a params whitelist: circular references become [Circular], functions/undefined/symbol are dropped (like JSON.stringify), BigInt is stringified, and objects with toJSON (e.g. Date, bson ObjectId) are serialized via it.
ts
import { } from 'feathers-utils/utils';Example
ts
import { stringifyParams } from 'feathers-utils/utils'
stringifyParams({ query: { name: 'John', age: 30 } })
// === stringifyParams({ query: { age: 30, name: 'John' } })Type declaration
Show Type Declarations
ts
/**
* Serializes Feathers `params` into a stable, deterministic string — built for
* generating cache keys.
*
* Two normalizations make semantically-equal params produce the same string:
* - **sortObject**: object keys are sorted recursively.
* - **sortArray**: elements of query array operators (`$or`, `$and`, `$nor`,
* `$not`, `$in`, `$nin`) are order-normalized.
*
* Serialization is crash-safe and never throws on values that leak through a
* params whitelist: circular references become `[Circular]`,
* functions/`undefined`/`symbol` are dropped (like `JSON.stringify`), `BigInt`
* is stringified, and objects with `toJSON` (e.g. `Date`, bson `ObjectId`) are
* serialized via it.
*
* @example
* ```ts
*
*
* stringifyParams({ query: { name: 'John', age: 30 } })
* // === stringifyParams({ query: { age: 30, name: 'John' } })
* ```
*
* @see https://utils.feathersjs.com/utils/stringify-params.html
*/
export declare const stringifyParams: (params: Params) => string| Argument | Type | Description |
|---|---|---|
| params | Params |