Stone.js API
    Preparing search index...

    A minimal key -> handler router.

    The small sibling of the full path Router: no paths, params, constraints or groups, just "this key maps to this handler". It is the reusable core behind job dispatch (job name -> handler), bus events (event name -> handler), realtime events, CLI commands (command -> handler) and the light KeyRoutingEventHandler. Handlers may be plain functions or objects/instances with an action method.

    Index
    • Resolve and invoke the handler for a key.

      Type Parameters

      • R = unknown

      Parameters

      • key: string

        The routing key.

      • ...args: any[]

        The arguments to pass to the handler.

      Returns Promise<R>

      The handler's result.

      When no handler is registered.

    • Whether a handler is registered for a key.

      Parameters

      • key: string

        The routing key.

      Returns boolean

      True if registered.

    • The registered keys.

      Returns string[]

      The keys.

    • Register a handler for a key.

      Parameters

      • key: string

        The routing key.

      • handler: KeyRouteHandler

        The handler (function or object with an action method).

      • action: string = 'handle'

        The method to call for object handlers (defaults to handle).

      Returns this

      This router for chaining.

    • Resolve the handler for a key.

      Parameters

      • key: string

        The routing key.

      Returns KeyHandlerFn

      The normalized handler function.

      When no handler is registered.

    • Resolve the handler for a key, or undefined when absent.

      Parameters

      • key: string

        The routing key.

      Returns KeyHandlerFn

      The handler, or undefined.