Class Route

constructor

• new Route(
      logger: LoggerInstance,
      route: definedApiRouteSchema,
      apiService: ServiceSchema<ApiSettingsSchemaOpenApi>,
      openApiService?: ServiceSchema<
          OpenApiMixinSettings,
          Service<OpenApiMixinSettings>,
      >,
      skipUnresolvedActions?: boolean,
  ): Route

  Parameters

  • logger: LoggerInstance
  • route: definedApiRouteSchema
  • apiService: ServiceSchema<ApiSettingsSchemaOpenApi>
  • OptionalopenApiService: ServiceSchema<OpenApiMixinSettings, Service<OpenApiMixinSettings>>
  • skipUnresolvedActions: boolean = true

  Returns Route

Readonlyaliases

ReadonlyapiService

ReadonlyautoAliases

Optional ReadonlybodyParsers

Optional ReadonlybusboyConfig

Optional Readonlyopenapi

Optional ReadonlyopenApiService

Readonlypath

searchAlias

• searchAlias(alias: routeAlias): undefined | Alias

  Parameters

  • alias: routeAlias

  Returns undefined | Alias

StaticformatPath

• formatPath(
      routePath: string,
      apiService: ServiceSchema<ApiSettingsSchemaOpenApi>,
  ): string

  Parameters

  • routePath: string
  • apiService: ServiceSchema<ApiSettingsSchemaOpenApi>

  Returns string