Function defineRoute

Utility function to define a route.

Param: module

The EventHandler module.

Param: options

Route definition options.

Param: options.isFactory

Indicates that the handler is a factory function.

Param: options.isClass

Indicates that the handler is a class.

Param: options.action

The action name for the event handler.

Returns

The RouterBlueprint.

defineRoute<U extends IIncomingEvent = IIncomingEvent>(
    module: FunctionalEventHandler<U>,
    options: RouteDefinition<U, unknown> & {
        isClass?: undefined;
        isFactory?: undefined;
    },
): RouterBlueprint<StoneIncomingEvent>
Utility function to define a route with function-based handler.
Type Parameters
- U extends IIncomingEvent = IIncomingEvent
Parameters
- module: FunctionalEventHandler<U>
  The EventHandler module.
- options: RouteDefinition<U, unknown> & { isClass?: undefined; isFactory?: undefined }
  Optional route definition options.
Returns RouterBlueprint<StoneIncomingEvent>
The RouterBlueprint.
defineRoute<U extends IIncomingEvent = IIncomingEvent>(
    module: FactoryEventHandler<U>,
    options: RouteDefinition<U, unknown> & {
        isClass?: undefined;
        isFactory: true;
    },
): RouterBlueprint<StoneIncomingEvent>
Utility function to define a route with factory-based handler.
Type Parameters
- U extends IIncomingEvent = IIncomingEvent
Parameters
- module: FactoryEventHandler<U>
  The EventHandler module.
- options: RouteDefinition<U, unknown> & { isClass?: undefined; isFactory: true }
  Route definition options with isFactory set to true.
  - OptionalisClass?: undefined
  - isFactory: true
    
    Indicates that the handler is a factory function.
Returns RouterBlueprint<StoneIncomingEvent>
The RouterBlueprint.
defineRoute<U extends IIncomingEvent = IIncomingEvent>(
    module: EventHandlerClass<U>,
    options: RouteDefinition<U, unknown> & {
        action: string;
        isClass: true;
        isFactory?: undefined;
    },
): RouterBlueprint<StoneIncomingEvent>
Utility function to define a route with class-based handler.
Type Parameters
- U extends IIncomingEvent = IIncomingEvent
Parameters
- module: EventHandlerClass<U>
  The EventHandler module.
- options: RouteDefinition<U, unknown> & {
      action: string;
      isClass: true;
      isFactory?: undefined;
  }
  Route definition options with isClass and action.
  - action: string
    
    The action name for the event handler.
  - isClass: true
    
    Indicates that the handler is a class.
  - OptionalisFactory?: undefined
Returns RouterBlueprint<StoneIncomingEvent>
The RouterBlueprint.