Class BasePodIdRoute

Implementation of an PodIdRoute that adds the identifier relative to a base AccountIdRoute.

Hierarchy (view full)

IdInteractionRoute<AccountIdKey, PodIdKey>
- BasePodIdRoute

Index

Constructors

Methods

getPath matchPath

Constructors

constructor

new BasePodIdRoute(base): BasePodIdRoute
Parameters
- base: AccountIdRoute
Returns BasePodIdRoute
Overrides IdInteractionRoute.constructor
- Defined in src/identity/interaction/pod/PodIdRoute.ts:16

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
- Optionalparameters: Record<"accountId" | "podId", string>
  Values for the dynamic parameters.
Returns string
Inherited from IdInteractionRoute.getPath
- Defined in src/identity/interaction/routing/IdInteractionRoute.ts:19

matchPath

matchPath(path): undefined | Record<"accountId" | "podId", 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<"accountId" | "podId", string>
Inherited from IdInteractionRoute.matchPath
- Defined in src/identity/interaction/routing/IdInteractionRoute.ts:29