Class QueryParams

Wraps a URL's query parameters in an object with type conversion accessors.

Hierarchy

QueryParams

Index

Methods

get getNumber isPresent serialize

Methods

get

get(key: string): undefined | string
Gets a string value by key, returning undefined if the key isn't present.

Returns
the param value
Parameters
- key: string
  
  the param key
Returns undefined | string
- Defined in src/urls.ts:17

getNumber

getNumber(key: string): undefined | number
Gets a number value by key, returning undefined if the key isn't present.

Returns
the converted param value
Parameters
- key: string
  
  the param key
Returns undefined | number
- Defined in src/urls.ts:26

isPresent

isPresent(key: string): boolean
Returns
true if the key is present in the params
Parameters
- key: string
  
  the param key
Returns boolean
- Defined in src/urls.ts:37

serialize

serialize(path?: string): string
Serializes the params to a query string.
Parameters
- Optional path: string
  
  the (optional) root path to prepend to the query string
Returns string
- Defined in src/urls.ts:45

Generated using TypeDoc