Class RouteMapper<IncomingEventType, OutgoingResponseType>

Maps route definitions into concrete Route instances.

Type Parameters

IncomingEventType extends IIncomingEvent = IIncomingEvent
Represents the type of incoming HTTP events.
OutgoingResponseType = unknown
Represents the type of outgoing HTTP responses.

Index

Constructors

Methods

toRoutes create

Constructors

constructor

new RouteMapper<
    IncomingEventType extends IIncomingEvent = IIncomingEvent,
    OutgoingResponseType = unknown,
>(
    options: RouteMapperOptions<IncomingEventType, OutgoingResponseType>,
): RouteMapper<IncomingEventType, OutgoingResponseType>
Constructs a RouteMapper instance.
Type Parameters
- IncomingEventType extends IIncomingEvent = IIncomingEvent
  Represents the type of incoming HTTP events.
- OutgoingResponseType = unknown
  Represents the type of outgoing HTTP responses.
Parameters
- options: RouteMapperOptions<IncomingEventType, OutgoingResponseType>
  Configuration options for the RouteMapper.
Returns RouteMapper<IncomingEventType, OutgoingResponseType>

Throws
If maxDepth is not a positive integer.

Methods

toRoutes

toRoutes(
definitions: RouteDefinition<IncomingEventType, OutgoingResponseType>[],
): Route<IncomingEventType, OutgoingResponseType>[]
Maps route definitions into Route instances.
Parameters
- definitions: RouteDefinition<IncomingEventType, OutgoingResponseType>[]
  An array of route definitions.
Returns Route<IncomingEventType, OutgoingResponseType>[]
An array of Route instances.

`Static`create

create<
    IncomingEventType extends IIncomingEvent = IIncomingEvent,
    OutgoingResponseType = unknown,
>(
    options: RouteMapperOptions<IncomingEventType, OutgoingResponseType>,
): RouteMapper<IncomingEventType, OutgoingResponseType>
Factory method to create a RouteMapper instance.
Type Parameters
- IncomingEventType extends IIncomingEvent = IIncomingEvent
- OutgoingResponseType = unknown
Parameters
- options: RouteMapperOptions<IncomingEventType, OutgoingResponseType>
  Configuration options for the RouteMapper.
Returns RouteMapper<IncomingEventType, OutgoingResponseType>
A new RouteMapper instance.