module@warp-drive/utilities/handlers

Class Gate

Defined in: -private/handlers/gated.ts:17

Implements

• Handler

Constructors

Constructor

new Gate(handler: Handler, checkFn: CheckFn): Gate;

Defined in: -private/handlers/gated.ts:27

Parameters

handler

Handler

checkFn

CheckFn

Returns

Gate

Methods

request()

request<T = unknown>(context: RequestContext, next: NextFn<T>): 
  | Promise<T | StructuredDataDocument<T>>
| Future<T>;

Defined in: -private/handlers/gated.ts:32

Method to implement to handle requests. Receives the request context and a nextFn to call to pass-along the request to other handlers.

Type Parameters

T

T = unknown

Parameters

context

RequestContext

next

NextFn<T>

Returns

| Promise<T | StructuredDataDocument<T>> | Future<T>

Implementation of

Handler.request

Properties

checkFn

checkFn: CheckFn;

Defined in: -private/handlers/gated.ts:25

The predicate used to decide whether handler should run for a given request.

---

handler

handler: Handler;

Defined in: -private/handlers/gated.ts:21

The wrapped handler to invoke when checkFn returns true.