Class EmailRouter<In>

Type Parameters

In extends Context = Context

Hierarchy

EmailRouter

Implements

Middleware<In>

Index

Constructors

Accessors

Methods

checkout handle match process

Constructors

constructor

new EmailRouter<In>(config?): EmailRouter<In>
Type Parameters
- In extends Context = Context
Parameters
- Optional config: EmailRouterConfig
Returns EmailRouter<In>
- Defined in packages/router/dist/index.d.ts:20

Properties

`Protected` config

config: EmailRouterConfig

`Protected` rules

rules: EmailRouteRule[]

Accessors

name

get name(): string
Returns string
Implementation of Middleware.name
- Defined in packages/router/dist/index.d.ts:21

Methods

checkout

checkout(message): Promise<null | EmailRouteRule>
Matches the given email message against the defined rules and returns the first matching rule.
Parameters
- message: EnhancedMessage
  The email message to match against the rules.
Returns Promise<null | EmailRouteRule>
The first matching rule or null if no rule matches the message.
- Defined in packages/router/dist/index.d.ts:27

handle

handle(ctx, next?): Promise<void>
Parameters
- ctx: In
- Optional next: ((c) => Promise<void>)
  - - (c): Promise<void>
    - Parameters
      c: In
      Returns Promise<void>
Returns Promise<void>
Implementation of Middleware.handle
- Defined in packages/router/dist/index.d.ts:35

match

match(matcher, handler): EmailRouter<In>
Adds a new route rule to the router's list of rules. The first added rule will be checked first.
Parameters
- matcher: EmailMatcher
  The matcher to use for this rule. Can be a string, a regular expression, or a function.
- handler: Middleware<Context, Context> | EmailHandler
  The handler to use for this rule. Can be a function handler or a middleware.
Returns EmailRouter<In>
The router itself.
- Defined in packages/router/dist/index.d.ts:43
match(matcher, subrouter): EmailRouter<In>
Parameters
- matcher: EmailMatcher
- subrouter: EmailRouter<Context>
Returns EmailRouter<In>
- Defined in packages/router/dist/index.d.ts:44

process

process(ctx, next?): Promise<EmailRouteHandleResult>
Processes the email message and returns the result of the matching route handle.
Parameters
- ctx: In
  The email context object.
- Optional next: ((c) => Promise<void>)
  The next middleware function.
  - - (c): Promise<void>
    - Parameters
      c: In
      Returns Promise<void>
Returns Promise<EmailRouteHandleResult>
An object containing the matched route handle or null if no match was found.
- Defined in packages/router/dist/index.d.ts:34

Generated using TypeDoc