Class Params

GET/POST parameter class.

Hierarchy

URLSearchParams
- Params

Index

Constructors

Properties

Accessors

Methods

[iterator] append delete entries forEach get getAll has keys removeEmpty set sort toObject values

Constructors

constructor

new Params(
init?: string | Record<string, string> | URLSearchParams | string[][],
): Params
Parameters
- Optionalinit: string | Record<string, string> | URLSearchParams | string[][]
Returns Params
Inherited from URLSearchParams.constructor
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:547

Properties

`Readonly`size

size: number

Accessors

isEmpty

get isEmpty(): boolean
Check if parameters are empty.

Returns boolean
- Defined in mojo.js-main/src/body/params.ts:10

Methods

[iterator]

"[iterator]"(): URLSearchParamsIterator<[string, string]>
Returns URLSearchParamsIterator<[string, string]>
Inherited from URLSearchParams.[iterator]
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:540

append

append(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void
Inherited from URLSearchParams.append
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:532

delete

delete(name: string, value?: string): void
Parameters
- name: string
- Optionalvalue: string
Returns void
Inherited from URLSearchParams.delete
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:533

entries

entries(): URLSearchParamsIterator<[string, string]>
Returns URLSearchParamsIterator<[string, string]>
Inherited from URLSearchParams.entries
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:541

forEach

forEach(
    callbackfn: (
        value: string,
        key: string,
        parent: URLSearchParams,
    ) => void,
    thisArg?: any,
): void
Parameters
- callbackfn: (value: string, key: string, parent: URLSearchParams) => void
- OptionalthisArg: any
Returns void
Inherited from URLSearchParams.forEach
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:539

get

get(name: string): string | null
Parameters
- name: string
Returns string | null
Inherited from URLSearchParams.get
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:534

getAll

getAll(name: string): string[]
Parameters
- name: string
Returns string[]
Inherited from URLSearchParams.getAll
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:535

has

has(name: string, value?: string): boolean
Parameters
- name: string
- Optionalvalue: string
Returns boolean
Inherited from URLSearchParams.has
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:536

keys

keys(): URLSearchParamsIterator<string>
Returns URLSearchParamsIterator<string>
Inherited from URLSearchParams.keys
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:542

removeEmpty

removeEmpty(): Params
Returns Params
- Defined in mojo.js-main/src/body/params.ts:17

set

set(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void
Inherited from URLSearchParams.set
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:537

sort

sort(): void
Returns void
Inherited from URLSearchParams.sort
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:538

toObject

toObject<T extends Record<string, any>>(): T
Convert parameters into a plain object, useful for validation.
Type Parameters
- T extends Record<string, any>
Returns T
- Defined in mojo.js-main/src/body/params.ts:28

values

values(): URLSearchParamsIterator<string>
Returns URLSearchParamsIterator<string>
Inherited from URLSearchParams.values
- Defined in mojo.js-main/node_modules/@types/node/url.d.ts:543