Class Router

Default router implementation of Zibri.

Implements

Index

Constructors

Properties

manuallyRegisteredRoutes

Methods

onAppInit onAppStart registerController registerRoute

Constructors

constructor

new Router(
    logger: LoggerInterface,
    parser: ParserInterface,
    validationService: ValidationServiceInterface,
    authService: AuthServiceInterface,
): Router
Parameters
- logger: LoggerInterface
- parser: ParserInterface
- validationService: ValidationServiceInterface
- authService: AuthServiceInterface
Returns Router
- Defined in src/routing/router.ts:55

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

onAppInit

onAppInit(app: ZibriApplication): Promise<void>
Runs when the app initializes.
Parameters
- app: ZibriApplication
Returns Promise<void>
Implementation of OnAppInit.onAppInit
- Defined in src/routing/router.ts:67

onAppStart

onAppStart(app: ZibriApplication): void
Runs when the app starts.
Parameters
- app: ZibriApplication
Returns void
Implementation of OnAppStart.onAppStart
- Defined in src/routing/router.ts:78

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:196

registerRoute

registerRoute<
    BodyMetaInputObject extends
        Partial<OmitStrict<BodyMetadata, "maxSize" | "modelClass" | "index">> & {
            baseMaxSize?: FileSize;
        } & { 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, "maxSize" | "modelClass" | "index">> & {
  baseMaxSize?: FileSize;
  } & { 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.registerRoute
- Defined in src/routing/router.ts:98