Class ChURIParams<TCharge>`Abstract`

Abstract parameters of charged URI. A base class for search parameters, matrix parameters, and hash parameters.

Resembles standard URLSearchParams class in its read-only part.

Type Parameters

out TCharge = URICharge

URI charge representation type. URICharge by default.

Hierarchy

ChURIParams

Implements

Iterable<[string, string]>

Index

Constructors

constructor

new ChURIParams<out TCharge>(params, parser?): ChURIParams<TCharge>
Constructs search parameters.
Type Parameters
- out TCharge = URICharge
Parameters
- params: string | Iterable<readonly [string, undefined | null | string]> | Readonly<Record<string, undefined | null | string>>
  
  Either a string containing parameters to parse (a prefix symbol is ignored), an iterable of key/value pairs representing string parameter values, or a record of string keys and string values.
- parser: ((this, rawValues, name, params) => TCharge) = ...
  
  Parser of parameter charges.
  - - (this, rawValues, name, params): TCharge
    - Parameters
      
      this: void
      
      rawValues: string[]
      
      name: null | string
      
      params: ChURIParams<TCharge>
      
      Returns TCharge
Returns ChURIParams<TCharge>
- Defined in ucnot/churi/src/uri/churi-params.ts:55

Accessors

`Static` splitter

get splitter(): ChURIParamSplitter
Search parameters splitter.

Splits parameters separated by "&" (U+0026) symbol by default.

Returns ChURIParamSplitter
- Defined in ucnot/churi/src/uri/churi-params.ts:35

arg

get arg(): TCharge
Obtains positional argument.

The very first parameter is treated as positional argument unless it contains an equals sign (= (U+003D)), i.e. the first named parameter name and value.

Returns TCharge
- Defined in ucnot/churi/src/uri/churi-params.ts:81

Methods

[iterator]

[iterator](): IterableIterator<[string, string]>
Iterates over all key/value pairs contained in this object. The key and value of each pair are string objects.

The same as entries.

Returns IterableIterator<[string, string]>
An iterable iterator of parameter name/value pairs in order of their appearance.
Implementation of Iterable.[iterator]
- Defined in ucnot/churi/src/uri/churi-params.ts:211

entries

entries(): IterableIterator<[string, string]>
Iterates over all key/value pairs contained in this object. The key and value of each pair are string objects.

Returns IterableIterator<[string, string]>
An iterable iterator of parameter name/value pairs in order of their appearance.

See
URLSearchParams.entries().
- Defined in ucnot/churi/src/uri/churi-params.ts:173

forEach

forEach(callback): void
Iterates over all values contained in this object via a callback function.
Parameters
- callback: ((value, key, parent) => void)
  
  Function to execute on each element. Accepts parameter name, string parameter value, and this instance as arguments.
  - - (value, key, parent): void
    - Parameters
      
      value: string
      
      key: string
      
      parent: ChURIParams<TCharge>
      
      Returns void
Returns void

See
URLSearchParams.forEach().
- Defined in ucnot/churi/src/uri/churi-params.ts:200

get

get(name): null | string
Obtains the first value associated to the given search parameter.
Parameters
- name: string
  
  Target parameter name.
Returns null | string
A string if the given search parameter is found; otherwise, null.

See
URLSearchParams.get().
- Defined in ucnot/churi/src/uri/churi-params.ts:111

getAll

getAll(name): string[]
Obtains all the values associated with a given search parameter as an array.
Parameters
- name: string
  
  Target parameter name.
Returns string[]
An array of strings. Empty array if parameter absent.

See
URLSearchParams.getAll().
- Defined in ucnot/churi/src/uri/churi-params.ts:126

getCharge

getCharge(name): TCharge
Obtains a charge of the named parameter.
Parameters
- name: string
  
  Target parameter name.
Returns TCharge
Parameter charge.
- Defined in ucnot/churi/src/uri/churi-params.ts:139

has

has(name): boolean
Checks whether a parameter with the specified name present.
Parameters
- name: string
  
  Target parameter name.
Returns boolean
true if parameter present, or false otherwise.

See
URLSearchParams.has().
- Defined in ucnot/churi/src/uri/churi-params.ts:98

keys

keys(): IterableIterator<string>
Iterates over all keys contained in this object. The keys are string objects.

Returns IterableIterator<string>
An iterable iterator of parameter names in order of their appearance. Note that the same parameter name may be reported multiple times.

See
URLSearchParams.keys().
- Defined in ucnot/churi/src/uri/churi-params.ts:160

toString

toString(): string
Builds a query string.

Returns string
The string containing parameters joined with joiner symbol.
- Defined in ucnot/churi/src/uri/churi-params.ts:220

values

values(): IterableIterator<string>
Iterates over all values values contained in this object. The values are string objects.

Returns IterableIterator<string>
An iterable iterator of parameter values in order of their appearance.

See
URLSearchParams.values().
- Defined in ucnot/churi/src/uri/churi-params.ts:186

Class ChURIParams<TCharge>Abstract

Type Parameters

out TCharge = URICharge

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

out TCharge = URICharge

Parameters

params: string | Iterable<readonly [string, undefined | null | string]> | Readonly<Record<string, undefined | null | string>>

parser: ((this, rawValues, name, params) => TCharge) = ...

Parameters

this: void

rawValues: string[]

name: null | string

params: ChURIParams<TCharge>

Returns TCharge

Returns ChURIParams<TCharge>

Accessors

Static splitter

Returns ChURIParamSplitter

arg

Returns TCharge

Methods

[iterator]

Returns IterableIterator<[string, string]>

entries

Returns IterableIterator<[string, string]>

See

forEach

Parameters

callback: ((value, key, parent) => void)

Parameters

value: string

key: string

parent: ChURIParams<TCharge>

Returns void

Returns void

See

get

Parameters

name: string

Returns null | string

See

getAll

Parameters

name: string

Returns string[]

See

getCharge

Parameters

name: string

Returns TCharge

has

Parameters

name: string

Returns boolean

See

keys

Returns IterableIterator<string>

See

toString

Returns string

values

Returns IterableIterator<string>

See

Settings

Member Visibility

Theme

On This Page

Class ChURIParams<TCharge>`Abstract`

`Static` splitter