Class CallbackStep

The definition of a request rule step, which can be passed to Mockttp to define a rule.

Implementation of the step is not included in the definition classes, but instead exists in an *Impl class defined separately and used internally.

Hierarchy (view full)

Serializable
- CallbackStep

Implements

RequestStepDefinition

Index

Constructors

Properties

callback type isFinal

Methods

dispose explain

Constructors

constructor

new CallbackStep(callback): CallbackStep
Parameters
- callback: ((request: CompletedRequest) => MaybePromise<CallbackResponseResult>)
  - - (request): MaybePromise<CallbackResponseResult>
    - Parameters
      request: CompletedRequest
      Returns MaybePromise<CallbackResponseResult>
Returns CallbackStep
Overrides Serializable.constructor
- Defined in rules/requests/request-step-definitions.ts:320

Properties

callback

callback: ((request: CompletedRequest) => MaybePromise<CallbackResponseResult>)

`Readonly`type

type: "callback" = 'callback'

`Static` `Readonly`isFinal

isFinal = true

Methods

dispose

dispose(): void
Returns void
Implementation of RequestStepDefinition.dispose
Inherited from Serializable.dispose
- Defined in serialization/serialization.ts:98

explain

explain(): string
Returns string
Implementation of RequestStepDefinition.explain
- Defined in rules/requests/request-step-definitions.ts:326