Class FixedResponseStep

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
- FixedResponseStep

Implements

RequestStepDefinition

Index

Constructors

Properties

data? headers? status statusMessage? trailers? type isFinal

Methods

dispose explain

Constructors

constructor

new FixedResponseStep(status, statusMessage?, data?, headers?, trailers?): FixedResponseStep
Parameters
- status: number
- OptionalstatusMessage: string
- Optionaldata:
      | string
      | Uint8Array
      | Buffer
      | SerializedBuffer
- Optionalheaders: Headers
- Optionaltrailers: Trailers
Returns FixedResponseStep
Overrides Serializable.constructor
- Defined in rules/requests/request-step-definitions.ts:266

Properties

`Optional`data

data?:
    | string
    | Uint8Array
    | Buffer
    | SerializedBuffer

`Optional`headers

headers?: Headers

status

status: number

`Optional`statusMessage

statusMessage?: string

`Optional`trailers

trailers?: Trailers

`Readonly`type

type: "simple" = 'simple'

`Static` `Readonly`isFinal

isFinal = true

Methods

dispose

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

explain

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