Interface EndpointRegistration

A registered endpoint pairing its metadata (method, path, schemas) with the handler function and any per-endpoint middleware.

interface EndpointRegistration {
    endpoint: EndpointMetadata;
    errors?: ErrorMap<any, any>;
    handler: (...args: any[]) => any;
    handlerErrorsMapped?: boolean;
    idempotency?: EndpointIdempotencyLimits & {
        scope: (...args: any[]) => IdempotencyScope | Promise<IdempotencyScope>;
    };
    middlewares?: readonly Middleware[];
    prepare?: (...args: any[]) => any;
}

Hierarchy

RuntimeEndpointOptions
- EndpointRegistration

Index

Properties

endpoint errors? handler handlerErrorsMapped? idempotency? middlewares? prepare?

Properties

`Readonly`endpoint

endpoint: EndpointMetadata

`Optional`errors

errors?: ErrorMap<any, any>

`Readonly`handler

handler: (...args: any[]) => any

`Optional` `Internal`handlerErrorsMapped

handlerErrorsMapped?: boolean

Handler invocation already owns its error policy.

`Optional`idempotency

idempotency?: EndpointIdempotencyLimits & {
scope: (...args: any[]) => IdempotencyScope | Promise<IdempotencyScope>;
}

`Optional` `Readonly`middlewares

middlewares?: readonly Middleware[]

`Optional`prepare

prepare?: (...args: any[]) => any