Interface: RouteOptions<IncomingEventType, OutgoingResponseType>

Defines the options for creating a Route instance.

Extends

• RouteDefinition<IncomingEventType, OutgoingResponseType>

Type Parameters

IncomingEventType

IncomingEventType extends IIncomingEvent = IIncomingEvent

OutgoingResponseType

OutgoingResponseType = unknown

Indexable

[k: string]: unknown

Properties

bindings?

optional bindings: Record<string, 
  | string
  | BindingResolver
| IBoundModel>;

Inherited from

RouteDefinition.bindings

---

children?

optional children: undefined;

Overrides

RouteDefinition.children

---

defaults?

optional defaults: Record<string, unknown>;

Inherited from

RouteDefinition.defaults

---

domain?

optional domain: string;

Overrides

RouteDefinition.domain

---

excludeMiddleware?

optional excludeMiddleware: PipeType<IncomingEventType, OutgoingResponseType>[];

Inherited from

RouteDefinition.excludeMiddleware

---

fallback?

optional fallback: boolean;

Inherited from

RouteDefinition.fallback

---

handler?

optional handler: MixedEventHandler<IncomingEventType, OutgoingResponseType>;

Inherited from

RouteDefinition.handler

---

isInternalHeader?

optional isInternalHeader: boolean;

Inherited from

RouteDefinition.isInternalHeader

---

method

method: HttpMethod;

Overrides

RouteDefinition.method

---

methods?

optional methods: undefined;

Overrides

RouteDefinition.methods

---

middleware?

optional middleware: MixedPipe<IncomingEventType, OutgoingResponseType>[];

Inherited from

RouteDefinition.middleware

---

name?

optional name: string;

Inherited from

RouteDefinition.name

---

path

path: string;

Overrides

RouteDefinition.path

---

protocol?

optional protocol: string;

Overrides

RouteDefinition.protocol

---

redirect?

optional redirect: 
  | string
  | Record<string, unknown>
| RouteDefinitionRedirect<IncomingEventType, unknown>;

Inherited from

RouteDefinition.redirect

---

rules?

optional rules: Record<string, string | RegExp>;

Inherited from

RouteDefinition.rules

---

strict?

optional strict: boolean;

Inherited from

RouteDefinition.strict