vue-mvvm

Appearance

vue-mvvm / router / RouterParams

RouterParams ​

Wrapper class for resolving path parameters

Methods ​

getInteger() ​

ts
getInteger(name): number;

Returns a route parameter as integer.

Parameters ​

name ​

string

Returns ​

number

Deprecated ​

Use getIntegerOrDefault or getIntegerOrThrow instead

getIntegerOrDefault() ​

Call Signature ​

ts
getIntegerOrDefault(name, many?): number | null;

Retrieves an integer path parameter.

If the parameter is missing or cannot be parsed as a safe integer, null is returned.

Parameters ​
name ​

string

The path parameter name.

many? ​

false

Reads multiple values of the parameter (See overload).

Returns ​

number | null

A integer or null

Call Signature ​

ts
getIntegerOrDefault(
   name, 
   many, 
   strict): number[] | null;

Retrieves an integer path parameter.

If the parameter is missing or cannot be parsed as a safe integer, null is returned.

If strict is enabled, the method returns null if any value cannot be parsed as an integer, otherwise the faulty value is ignored

Parameters ​
name ​

string

The path parameter name.

many ​

true

Reads multiple values of the parameter.

strict ​

boolean

When true, parsing fails if any value is invalid.

Returns ​

number[] | null

A integer array or null

getIntegerOrThrow() ​

Call Signature ​

ts
getIntegerOrThrow(name, many?): number;

Retrieves an integer path parameter.

Throws an error if the parameter does not exist or cannot be parsed as a safe integer.

Parameters ​
name ​

string

The query parameter name.

many? ​

false

Reads multiple values of the parameter (See overload).

Returns ​

number

A integer

Throws ​

If the parameter is missing or cannot be parsed.

Call Signature ​

ts
getIntegerOrThrow(
   name, 
   many, 
   strict): number[];

Retrieves an integer path parameter.

Throws an error if the parameter does not exist or cannot be parsed as a safe integer.

Parameters ​
name ​

string

The path parameter name.

many ​

true

Reads multiple values of the parameter.

strict ​

boolean

When true, parsing fails if any value is invalid.

Returns ​

number[]

A integer array

Throws ​

If the parameter is missing or cannot be parsed.

getString() ​

ts
getString(name): string;

Returns a route parameter as string.

Parameters ​

name ​

string

Returns ​

string

Deprecated ​

Use getStringOrDefault or getStringOrThrow instead

getStringOrDefault() ​

Call Signature ​

ts
getStringOrDefault(name, many?): string | null;

Retrieves a string path parameter.

If the parameter is missing, null is returned.

Parameters ​
name ​

string

The path parameter name.

many? ​

false

Reads multiple values of the parameter (See overload).

Returns ​

string | null

A string or null

Call Signature ​

ts
getStringOrDefault(name, many): string[] | null;

Retrieves a string path parameter.

If the parameter is missing, null is returned.

Parameters ​
name ​

string

The query parameter name.

many ​

true

Reads multiple values of the parameter.

Returns ​

string[] | null

A string array or null

getStringOrThrow() ​

Call Signature ​

ts
getStringOrThrow(name, many?): string;

Retrieves a string path parameter.

Throws an error if the parameter does not exist.

Parameters ​
name ​

string

The path parameter name.

many? ​

false

Reads multiple values of the parameter (See overload).

Returns ​

string

A string

Throws ​

If the parameter does not exist.

Call Signature ​

ts
getStringOrThrow(name, many): string[];

Retrieves a string path parameter.

Throws an error if the parameter does not exist.

Parameters ​
name ​

string

The path parameter name.

many ​

true

Reads multiple values of the parameter.

Returns ​

string[]

A string array

Throws ​

Error If the parameter does not exist.