Class FileStep

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

Implements

RequestStepDefinition

Index

Constructors

Properties

filePath headers? status statusMessage type isFinal

Methods

dispose explain

Constructors

constructor

new FileStep(status, statusMessage, filePath, headers?): FileStep
Parameters
- status: number
- statusMessage: undefined | string
- filePath: string
- Optionalheaders: Headers
Returns FileStep
Overrides Serializable.constructor
- Defined in rules/requests/request-step-definitions.ts:440

Properties

filePath

filePath: string

`Optional`headers

headers?: Headers

status

status: number

statusMessage

statusMessage: undefined | string

`Readonly`type

type: "file" = 'file'

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