Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICommandInterceptor

An interface for stackable command intercepters, which can extend and modify the command call chain.

This mechanism can be used for authentication, logging, and other functions.

see

ICommand

see

InterceptedCommand

Hierarchy

  • ICommandInterceptor

Index

Methods

Methods

execute

  • execute(correlationId: string, command: ICommand, args: Parameters, callback: function): void

  • Executes the wrapped command with specified arguments.

    The interceptor can use this method to intercept and alter the command execution. Otherwise it shall just delete the call to the wrapped command.

    see

    Parameters

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • command: ICommand

      the next command in the call chain that is to be executed.

    • args: Parameters

      the parameters (arguments) to pass to the command for execution.

    • callback: function

      the function that is to be called once execution is complete. If an exception is raised, then it will be called with the error.

        • (err: any, result: any): void

        • Parameters

          • err: any
          • result: any

          Returns void

    Returns void

getName

  • Gets the name of the wrapped command.

    The interceptor can use this method to override the command name. Otherwise it shall just delegate the call to the wrapped command.

    Parameters

    • command: ICommand

      the next command in the call chain.

    Returns string

    the name of the wrapped command.

validate

  • Validates arguments of the wrapped command before its execution.

    The interceptor can use this method to intercept and alter validation of the command arguments. Otherwise it shall just delegate the call to the wrapped command.

    see

    Parameters

    see

    ValidationResult

    Parameters

    • command: ICommand

      the next command in the call chain to be validated against.

    • args: Parameters

      the parameters (arguments) to validate.

    Returns ValidationResult[]

    an array of ValidationResults.

Generated using TypeDoc