Class StreamStep

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

Implements

RequestStepDefinition

Index

Constructors

Properties

headers? status stream type isFinal

Methods

dispose explain

Constructors

constructor

new StreamStep(status, stream, headers?): StreamStep
Parameters
- status: number
- stream: Readable & {
  done?: true;
  }
- Optionalheaders: Headers
Returns StreamStep
Overrides Serializable.constructor
- Defined in rules/requests/request-step-definitions.ts:378

Properties

`Optional`headers

headers?: Headers

status

status: number

stream

stream: Readable & {
done?: true;
}

`Readonly`type

type: "stream" = 'stream'

`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:388