Class Router

Hierarchy

Router

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Router(pod: Pod): Router

- Defined in packages/amagaki/src/router.ts:40
Parameters
- pod: Pod
Returns Router

Properties

pod

pod: Pod

providers

providers: Record<string, RouteProvider[]>

Methods

addProvider

addProvider(provider: RouteProvider): void

- Defined in packages/amagaki/src/router.ts:114
Parameters
- provider: RouteProvider
Returns void

addRoutes

addRoutes(type: string, builder: RouteBuilder): Promise<void>

- Defined in packages/amagaki/src/router.ts:147
Shortcut method for adding a route without subclassing Route and RouteProvider.

Parameters
- type: string
- builder: RouteBuilder
Returns Promise<void>

addStaticDirectoryRoutes

addStaticDirectoryRoutes(routeConfigs: StaticDirConfig[]): void

- Defined in packages/amagaki/src/router.ts:126
Used for setting static directory routes configuration.

Parameters
- routeConfigs: StaticDirConfig[]
  
  The configurations for the route definition.
Returns void

getUrl

getUrl(type: string, item: Document | StaticFile): Url

- Defined in packages/amagaki/src/router.ts:132
Parameters
- type: string
- item: Document | StaticFile
Returns Url

reset

reset(): void

- Defined in packages/amagaki/src/router.ts:82
Returns void

resolve

resolve(path: string): Promise<Route>

- Defined in packages/amagaki/src/router.ts:60
Parameters
- path: string
Returns Promise<Route>

routes

routes(): Promise<Route[]>

- Defined in packages/amagaki/src/router.ts:88
Returns Promise<Route[]>

warmup

warmup(): Promise<number>

- Defined in packages/amagaki/src/router.ts:75
Returns Promise<number>

Generated using TypeDoc