Interface Relay<O>

Relay.

Accepts handlers for each option and returns the result from the matched handler. Three usage patterns are supported:

All options handled: provide a handler for every option, returns R
Some options without fallback: provide handlers for some options only, returns R | undefined
Some options with fallback: provide handlers for some options plus a fallback, returns R

Type Parameters

O extends Options
The options type defining all possible option variants

Relay<R>(handlers: Handlers<O, R>): R
Handles all options with complete handlers.
Type Parameters
- R
  The return type of all handlers
Parameters
- handlers: Handlers<O, R>
  Mapping of all option keys to their handlers
Returns R
The result from the matched handler
- Defined in patterns/relay.ts:112
Relay<R>(handlers: Partial<Handlers<O, R>>): R | undefined
Handles some options without a fallback.
Type Parameters
- R
  The return type of all handlers
Parameters
- handlers: Partial<Handlers<O, R>>
  Partial mapping of option keys to handlers
Returns R | undefined
The result from the matched handler, or undefined if no handler matched
- Defined in patterns/relay.ts:122
Relay<R>(handlers: Partial<Handlers<O, R>>, fallback: Handler<O[keyof O], R>): R
Handles some options with a fallback handler for unmatched options.
Type Parameters
- R
  The return type of all handlers
Parameters
- handlers: Partial<Handlers<O, R>>
  Partial mapping of option keys to handlers
- fallback: Handler<O[keyof O], R>
  Handler for options without an entry in handlers, receiving the matched option value
Returns R
The result from the matched handler or fallback
- Defined in patterns/relay.ts:133