Docs
API
Interfaces
QueryStringOptions1

Interface: QueryStringOptions1

types/src.YamlConfig.QueryStringOptions1

Table of contents

Properties

Properties

arrayFormat

Optional arrayFormat: "indices" | "brackets" | "repeat" | "comma"

You can configure how to format arrays in the query strings.

Note: when using arrayFormat set to 'comma', you can also pass the commaRoundTrip option set to true or false, to append [] on single-item arrays, so that they can round trip through a parse. (Allowed values: indices, brackets, repeat, comma)

Defined in

packages/types/src/config.ts:547


commaRoundTrip

Optional commaRoundTrip: boolean

Even if there is a single item in an array, this option treats them as arrays (default: false)

Defined in

packages/types/src/config.ts:552


indices

Optional indices: boolean

When arrays are stringified, by default they are not given explicit indices: a=b&a=c&a=d You may override this by setting the indices option to true: a[0]=b&a[1]=c&a[2]=d

Defined in

packages/types/src/config.ts:541