"source/System/Uri/QueryParams"

Index

Modules

Separator

Functions

encode

encode(values: UriComponent.Map | QueryParam.EnumerableOrArray, prefixIfNotEmpty?: boolean): string

- Defined in source/System/Uri/QueryParams.ts:37
Returns the encoded URI string

Parameters
- values: UriComponent.Map | QueryParam.EnumerableOrArray
- Optional prefixIfNotEmpty: boolean
Returns string

encodeValue

encodeValue(value: UriComponent.Value): string

- Defined in source/System/Uri/QueryParams.ts:91
Converts any primitive, serializable or uri-component object to an encoded string.

Parameters
- value: UriComponent.Value
Returns string

isUriComponentFormattable

isUriComponentFormattable(instance: any): boolean

- Defined in source/System/Uri/QueryParams.ts:112
A shortcut for identifying an UriComponent.Formattable object.

Parameters
- instance: any
Returns boolean

parse

parse(query: string, entryHandler: function, deserialize?: boolean, decodeValues?: boolean): void

- Defined in source/System/Uri/QueryParams.ts:124
Parses a string for valid query param entries and pipes them through a handler.

Parameters
- query: string
- entryHandler: function
  - - (key: string, value: Primitive): void
    - Parameters
      - key: string
      - value: Primitive
      Returns void
- Default value deserialize: boolean = true
  
  Default is true.
- Default value decodeValues: boolean = true
  
  Default is true.
Returns void

parseToArray

parseToArray(query: string, deserialize?: boolean, decodeValues?: boolean): IStringKeyValuePair<Primitive>[]

- Defined in source/System/Uri/QueryParams.ts:190
Parses a string for valid query params and returns a key-value pair array of the entries.

Parameters
- query: string
- Default value deserialize: boolean = true
  
  Default is true.
- Default value decodeValues: boolean = true
  
  Default is true.
Returns IStringKeyValuePair<Primitive>[]

parseToMap

parseToMap(query: string, deserialize?: boolean, decodeValues?: boolean): IMap<Primitive | Primitive[]>

- Defined in source/System/Uri/QueryParams.ts:159
Parses a string for valid query params and returns a key-value map of the entries.

Parameters
- query: string
- Default value deserialize: boolean = true
  
  Default is true.
- Default value decodeValues: boolean = true
  
  Default is true.
Returns IMap<Primitive | Primitive[]>

Index

Modules

Functions

Functions

encode

Parameters

values: UriComponent.Map | QueryParam.EnumerableOrArray

Optional prefixIfNotEmpty: boolean

Returns string

encodeValue

Parameters

value: UriComponent.Value

Returns string

isUriComponentFormattable

Parameters

instance: any

Returns boolean

parse

Parameters

query: string

entryHandler: function

Parameters

key: string

value: Primitive

Returns void

Default value deserialize: boolean = true

Default value decodeValues: boolean = true

Returns void

parseToArray

Parameters

query: string

Default value deserialize: boolean = true

Default value decodeValues: boolean = true

Returns IStringKeyValuePair<Primitive>[]

parseToMap

Parameters

query: string

Default value deserialize: boolean = true

Default value decodeValues: boolean = true

Returns IMap<Primitive | Primitive[]>