Interface IWebRouter<APP_STATE, ROUTER_STATE>

interface IWebRouter<APP_STATE, ROUTER_STATE> {
    name: string;
    path: string;
    getState(): ROUTER_STATE;
    initialize(props: IWebRouterInitProps<APP_STATE>): Promise<void>;
    router(): any;
    toJson(): any;
    toString(): string;
}

Type Parameters

APP_STATE
ROUTER_STATE

Implemented by

WebRouter

Index

Properties

Methods

getState initialize router toJson toString

Properties

`Readonly`name

name: string

path

path: string

Methods

getState

getState(): ROUTER_STATE
Returns ROUTER_STATE
- Defined in src/router/web-router.ts:29

initialize

initialize(props: IWebRouterInitProps<APP_STATE>): Promise<void>
Parameters
- props: IWebRouterInitProps<APP_STATE>
Returns Promise<void>
- Defined in src/router/web-router.ts:27

router

router(): any
Returns any
- Defined in src/router/web-router.ts:28

toJson

toJson(): any
Returns any
- Defined in src/router/web-router.ts:31

toString

toString(): string
Returns string
- Defined in src/router/web-router.ts:32