Skip to content

Documentation / @ember-data/request-utils / index / buildQueryParams

ts
function buildQueryParams(params, options?): string;

Defined in: index.ts:551

Sorts query params by both key and value, returning a query params string

Treats included specially, splicing it into an array if it is a string and sorting the array.

Options:

  • arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'

'bracket': appends [] to the key for every value e.g. ids[]=1&ids[]=2 'indices': appends [i] to the key for every value e.g. ids[0]=1&ids[1]=2 'repeat': appends the key for every value e.g. ids=1&ids=2 'comma' (default): appends the key once with a comma separated list of values e.g. ids=1,2

Parameters

params

QueryParamsSource

options?

QueryParamsSerializationOptions

Returns

string

A sorted query params string without the leading ?

Released under the MIT License.