Class IdInteractionRoute<TBase, TId>

An InteractionRoute for routes that have a dynamic identifier in their path.

Type Parameters

TBase extends string
TId extends string

Hierarchy

IdInteractionRoute

Implements

InteractionRoute<TBase | TId>

Index

Constructors

Properties

base ensureSlash idName

Methods

getPath matchPath

Constructors

constructor

new IdInteractionRoute<TBase, TId>(base, idName, ensureSlash?): IdInteractionRoute<TBase, TId>
Type Parameters
- TBase extends string
- TId extends string
Parameters
- base: InteractionRoute<TBase>
- idName: TId
- ensureSlash: boolean = true
Returns IdInteractionRoute<TBase, TId>
- Defined in src/identity/interaction/routing/IdInteractionRoute.ts:13

Properties

`Private` `Readonly` base

base: InteractionRoute<TBase>

`Private` `Readonly` ensureSlash

ensureSlash: boolean

`Private` `Readonly` idName

idName: TId

Methods

getPath

getPath(parameters?): string
Returns the path that is the result of having the specified values for the dynamic parameters.

Will throw an error in case the input parameters object is missing one of the expected keys.
Parameters
- Optional parameters: Record<TBase | TId, string>
  
  Values for the dynamic parameters.
Returns string
Implementation of InteractionRoute.getPath
- Defined in src/identity/interaction/routing/IdInteractionRoute.ts:19

matchPath

matchPath(path): undefined | Record<TBase | TId, string>
Checks if the provided path matches the route (pattern).

The result will be undefined if there is no match.

If there is a match the result object will have the corresponding values for all the parameters.
Parameters
- path: string
  
  The path to verify.
Returns undefined | Record<TBase | TId, string>
Implementation of InteractionRoute.matchPath
- Defined in src/identity/interaction/routing/IdInteractionRoute.ts:29