Skip to main content
zerotal

Documentation

Documentation / @zerotal/auth / ValidateSignatureMiddleware

Class: ValidateSignatureMiddleware

Defined in: auth/src/ValidateSignatureMiddleware.ts:33

Base class for all Zerotal middlewares.

Subclasses must declare protected options with their default values. Use MyMiddleware.with({ ... }) to produce a zero-arg constructor with options deep-merged on top of the subclass defaults.

Example

class MyMiddleware extends BaseMiddleware<MyOptions> {
  protected options: MyOptions = { timeout: 5000 };

  async handle(ctx: HttpContext, next: NextFn): Promise<Response | void> {
    // ...read/write ctx.* ...
    return next();
  }
}

app.use([MyMiddleware.with({ timeout: 1000 })]);

Extends

Constructors

Constructor

new ValidateSignatureMiddleware(): ValidateSignatureMiddleware

Defined in: core/src/middleware/BaseMiddleware.ts:36

Returns

ValidateSignatureMiddleware

Inherited from

BaseMiddleware.constructor

Properties

options

protected options: Options = {}

Defined in: auth/src/ValidateSignatureMiddleware.ts:34

Subclasses must declare this with their default option values. TypeScript enforces this at compile time — forgetting it is a type error.

Overrides

BaseMiddleware.options

Methods

handle()

handle(http, next): Promise<void | Response>

Defined in: auth/src/ValidateSignatureMiddleware.ts:36

Parameters

http

HttpContext

next

NextFn

Returns

Promise<void | Response>

Overrides

BaseMiddleware.handle

onInvalid()

protected onInvalid(_ctx): Response

Defined in: auth/src/ValidateSignatureMiddleware.ts:52

Called when the signature is invalid or the link has expired. Override in a subclass to customise the error response.

Parameters

_ctx

HttpContext

Returns

Response

with()

static with<T, Opts>(this, options): () => InstanceType<T>

Defined in: core/src/middleware/BaseMiddleware.ts:48

Returns a zero-arg subclass with the given options deep-merged on top of the subclass defaults, usable directly in app.use([...]).

Type Parameters

T

T extends (...args) => BaseMiddleware<any>

Opts

Opts = T extends (...args) => BaseMiddleware<U> ? U : object

Parameters

this

T

options

Partial<Opts>

Returns

() => InstanceType<T>

Inherited from

BaseMiddleware.with

afterResponse()?

optional afterResponse(ctx): Promise<void>

Defined in: core/src/middleware/BaseMiddleware.ts:70

Parameters

ctx

HttpContext

Returns

Promise<void>

Inherited from

BaseMiddleware.afterResponse

onError()?

optional onError(ctx, error): Promise<void>

Defined in: core/src/middleware/BaseMiddleware.ts:71

Parameters

ctx

HttpContext

error

Error

Returns

Promise<void>

Inherited from

BaseMiddleware.onError