Type Alias OnRequestHook<Ports, C>

OnRequestHook: (
    args: {
        contract: C;
        params: Record<string, string>;
        ports: Ports;
        req: HttpRequestLike;
    },
) => MaybePromise<HttpResponse | undefined>

Hook that runs after a route is matched but before request parsing and context creation.

Returning a response short-circuits the rest of the request pipeline.

Type Parameters

Ports extends AnyPorts = AnyPorts
C extends HttpContractConfig = HttpContractConfig

Type Declaration

- (
      args: {
          contract: C;
          params: Record<string, string>;
          ports: Ports;
          req: HttpRequestLike;
      },
  ): MaybePromise<HttpResponse | undefined>
- Parameters
  - args: {
        contract: C;
        params: Record<string, string>;
        ports: Ports;
        req: HttpRequestLike;
    }
  Returns MaybePromise<HttpResponse | undefined>

Type Alias OnRequestHook<Ports, C>

Type Parameters

Type Declaration

Parameters

Returns MaybePromise<HttpResponse | undefined>

Settings