Skip to main content
Module

x/querystring/types.d.ts>StringifyOptions

Parse and stringify URL query strings
Latest
interface StringifyOptions
import { type StringifyOptions } from "https://deno.land/x/querystring@v1.0.2/types.d.ts";

Properties

readonly
optional
strict: boolean

Strictly encode URI components with strict-uri-encode. It uses encodeURIComponent if set to false. You probably don't care about this option.

readonly
optional
encode: boolean

URL encode the keys and values.

readonly
optional
arrayFormat:
| "bracket"
| "index"
| "comma"
| "separator"
| "bracket-separator"
| "none"
readonly
optional
arrayFormatSeparator: string

The character used to separate array elements when using {arrayFormat: 'separator'}.

readonly
optional
sort: ((itemLeft: string, itemRight: string) => number) | false

Supports both Function as a custom sorting function or false to disable sorting.

If omitted, keys are sorted using `Array#sort`, which means, converting them to strings and comparing strings in Unicode code point order.
readonly
optional
skipNull: boolean

Skip keys with null as the value.

Note that keys with `undefined` as the value are always skipped.
readonly
optional
skipEmptyString: boolean

Skip keys with an empty string as the value.