Class Router

Default router implementation of Zibri.

Implements

RouterInterface

Index

Constructors

Properties

manuallyRegisteredRoutes

Methods

attachTo init register registerController

Constructors

constructor

new Router(): Router
Returns Router
- Defined in src/routing/router.ts:45

Properties

`Readonly`manuallyRegisteredRoutes

manuallyRegisteredRoutes: RouteConfiguration<
    BodyMetadata,
    Record<string, PathParamMetadata>,
    Record<string, QueryParamMetadata>,
    Record<string, HeaderParamMetadata>,
>[] = []

All routes that have been manually registered by calling the .register method.

Methods

attachTo

attachTo(app: ZibriApplication): void
Attaches the router to the app.
Parameters
- app: ZibriApplication
Returns void
Implementation of RouterInterface.attachTo
- Defined in src/routing/router.ts:64

init

init(app: ZibriApplication): Promise<void>
Initializes the router, registers controllers etc.
Parameters
- app: ZibriApplication
Returns Promise<void>
Implementation of RouterInterface.init
- Defined in src/routing/router.ts:53

register

register<
    BodyMetaInputObject extends
        Partial<OmitStrict<BodyMetadata, "modelClass" | "index">> & {
            modelClass: Newable<unknown>;
        },
    PathMetaInputObject extends Record<string, PathParamMetadataInput>,
    QueryMetaInputObject extends Record<string, QueryParamMetadataInput>,
    HeaderMetaInputObject extends Record<string, HeaderParamMetadataInput>,
>(
    input: RouteConfigurationInput<
        BodyMetaInputObject,
        PathMetaInputObject,
        QueryMetaInputObject,
        HeaderMetaInputObject,
    >,
): Promise<void>
Register a route.
Type Parameters
- BodyMetaInputObject extends Partial<OmitStrict<BodyMetadata, "modelClass" | "index">> & {
  modelClass: Newable<unknown>;
  }
- PathMetaInputObject extends Record<string, PathParamMetadataInput>
- QueryMetaInputObject extends Record<string, QueryParamMetadataInput>
- HeaderMetaInputObject extends Record<string, HeaderParamMetadataInput>
Parameters
- input: RouteConfigurationInput<
      BodyMetaInputObject,
      PathMetaInputObject,
      QueryMetaInputObject,
      HeaderMetaInputObject,
  >
Returns Promise<void>
Implementation of RouterInterface.register
- Defined in src/routing/router.ts:84

registerController

registerController(controllerClass: Newable<unknown>): Promise<void>
Register a controller.
Parameters
- controllerClass: Newable<unknown>
Returns Promise<void>
Implementation of RouterInterface.registerController
- Defined in src/routing/router.ts:180