Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MockttpServer

A in-process Mockttp implementation. This starts servers on the local machine in the current process, and exposes methods to directly manage them.

This class does not work in browsers, as it expects to be able to start HTTP servers.

Hierarchy

  • AbstractMockttp
    • MockttpServer

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private app

app: express.Application

Protected cors

cors: boolean

Protected debug

debug: boolean

Private eventEmitter

eventEmitter: EventEmitter

Private httpsOptions

httpsOptions: CAOptions | undefined

Private rules

rules: MockRule[] = []

Private server

server: DestroyableServer | undefined

Accessors

mockedEndpoints

port

  • get port(): number

proxyEnv

url

  • get url(): string

Methods

addRule

Private announceRequestAsync

anyRequest

delete

enableDebug

  • enableDebug(): void

Private explainRequest

get

Private handleRequest

  • handleRequest(request: OngoingRequest, response: express.Response): Promise<void>

Private isComplete

on

  • on(event: "request", callback: function): Promise<void>

options

patch

post

put

reset

  • reset(): void

start

  • start(portParam?: undefined | number): Promise<void>

stop

  • stop(): Promise<void>

Private suggestRule

urlFor

  • urlFor(path: string): string

  • Parameters

    • path: string

    Returns string

Generated using TypeDoc