Usage

Encode query or form parameters.

tsx
// Encode query or form parameters.
const params = new URLSearchParams({ q: 'kuito', page: '2' });

params.append('tag', 'native');
params.toString(); // 'q=kuito&page=2&tag=native'

await fetch('https://example.com/search', { method: 'POST', body: params });

Constructors

ts
(init?: string | [string, string][] | Record<string, string> | URLSearchParams): URLSearchParams

Parameters

NameTypeRequiredDescription
initstring | Record<string, string> | [string, string][] | URLSearchParamsNo—

Returns

URLSearchParams

Properties and methods 14

NameTypeRequiredDescription
prototypereadonlyURLSearchParamsYes—
sizereadonlynumberYes—
append(name: string, value: string) => voidYes—
delete(name: string, value?: string) => voidYes—
get(name: string) => string | nullYes—
getAll(name: string) => string[]Yes—
has(name: string, value?: string) => booleanYes—
set(name: string, value: string) => voidYes—
sort() => voidYes—
forEach(callback: (value: string, name: string, params: URLSearchParams) => void) => voidYes—
keys() => IterableIterator<string>Yes—
values() => IterableIterator<string>Yes—
entries() => IterableIterator<[string, string]>Yes—
toString() => stringYesapplication/x-www-form-urlencoded: spaces as +.
append — method signatures

Signatures

ts
(name: string, value: string): void

Parameters

NameTypeRequiredDescription
namestringYes—
valuestringYes—

Returns

void

delete — method signatures

Signatures

ts
(name: string, value?: string): void

Parameters

NameTypeRequiredDescription
namestringYes—
valuestringNo—

Returns

void

get — method signatures

Signatures

ts
(name: string): string | null

Parameters

NameTypeRequiredDescription
namestringYes—

Returns

string

getAll — method signatures

Signatures

ts
(name: string): string[]

Parameters

NameTypeRequiredDescription
namestringYes—

Returns

string[]

has — method signatures

Signatures

ts
(name: string, value?: string): boolean

Parameters

NameTypeRequiredDescription
namestringYes—
valuestringNo—

Returns

boolean

set — method signatures

Signatures

ts
(name: string, value: string): void

Parameters

NameTypeRequiredDescription
namestringYes—
valuestringYes—

Returns

void

sort — method signatures

Signatures

ts
(): void

Parameters

No parameters.

Returns

void

forEach — method signatures

Signatures

ts
(callback: (value: string, name: string, params: URLSearchParams) => void): void

Parameters

NameTypeRequiredDescription
callback(value: string, name: string, params: URLSearchParams) => voidYes—

Returns

void

keys — method signatures

Signatures

ts
(): IterableIterator<string>

Parameters

No parameters.

Returns

IterableIterator<string>

values — method signatures

Signatures

ts
(): IterableIterator<string>

Parameters

No parameters.

Returns

IterableIterator<string>

entries — method signatures

Signatures

ts
(): IterableIterator<[string, string]>

Parameters

No parameters.

Returns

IterableIterator<[string, string]>

toString — method signatures

Signatures

ts
(): string

Parameters

No parameters.

Returns

string

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.