Function registerHttpApiHandler

registerHttpApiHandler<
    ReqHeadersT extends AnyHeaders,
    ReqParamsT extends AnyParams,
    ReqQueryT extends AnyQuery,
    ReqBodyT extends unknown,
    ResStatusT extends number,
    ResHeadersT extends AnyHeaders,
    ResBodyT extends unknown,
    ErrResStatusT extends number,
    ErrResHeadersT extends AnyHeaders,
    ErrResBodyT extends unknown,
>(
    app: Express & YaschemaApiExpressContextAccessor,
    api: HttpApi<
        ReqHeadersT,
        ReqParamsT,
        ReqQueryT,
        ReqBodyT,
        ResStatusT,
        ResHeadersT,
        ResBodyT,
        ErrResStatusT,
        ErrResHeadersT,
        ErrResBodyT,
    >,
    __namedParameters: HttpApiHandlerOptions,
    handler: HttpApiHandler<
        ReqHeadersT,
        ReqParamsT,
        ReqQueryT,
        ReqBodyT,
        ResStatusT,
        ResHeadersT,
        ResBodyT,
        ErrResStatusT,
        ErrResHeadersT,
        ErrResBodyT,
    >,
): void
Be sure to call finalizeApiHandlerRegistrations once all API registrations have been added.
Type Parameters
- ReqHeadersT extends AnyHeaders
- ReqParamsT extends AnyParams
- ReqQueryT extends AnyQuery
- ReqBodyT extends unknown
- ResStatusT extends number
- ResHeadersT extends AnyHeaders
- ResBodyT extends unknown
- ErrResStatusT extends number
- ErrResHeadersT extends AnyHeaders
- ErrResBodyT extends unknown
Parameters
- app: Express & YaschemaApiExpressContextAccessor
- api: HttpApi<
      ReqHeadersT,
      ReqParamsT,
      ReqQueryT,
      ReqBodyT,
      ResStatusT,
      ResHeadersT,
      ResBodyT,
      ErrResStatusT,
      ErrResHeadersT,
      ErrResBodyT,
  >
- __namedParameters: HttpApiHandlerOptions
- handler: HttpApiHandler<
      ReqHeadersT,
      ReqParamsT,
      ReqQueryT,
      ReqBodyT,
      ResStatusT,
      ResHeadersT,
      ResBodyT,
      ErrResStatusT,
      ErrResHeadersT,
      ErrResBodyT,
  >
Returns void
- Defined in src/register-http-api-handler/register-http-api-handler.ts:42

Function registerHttpApiHandler

Type Parameters

Parameters

Returns void

Settings