Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MockttpClient

A Mockttp implementation, controlling a remote Mockttp standalone server.

This starts servers by making requests to the remote standalone server, and exposes methods to directly manage them.

Hierarchy

  • AbstractMockttp
    • MockttpClient

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected cors

cors: boolean

Protected debug

debug: boolean

Private mockServerConfig

mockServerConfig: MockServerConfig | undefined

Private mockServerOptions

mockServerOptions: MockttpOptions

Private standaloneServerUrl

standaloneServerUrl: string = `http://localhost:${DEFAULT_STANDALONE_PORT}`

Accessors

port

  • get port(): number

proxyEnv

url

  • get url(): string

Methods

addRule

anyRequest

delete

enableDebug

  • enableDebug(): void

get

Private getEndpointData

  • getEndpointData(ruleId: string): (Anonymous function)

on

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

options

patch

post

put

Private queryMockServer

  • queryMockServer<T>(query: string, variables?: undefined | __type): Promise<T>

  • Type parameters

    • T

    Parameters

    • query: string
    • Optional variables: undefined | __type

    Returns Promise<T>

Private requestFromMockServer

  • requestFromMockServer<T>(path: string, options?: RequestInit): Promise<T>

Private requestFromStandalone

  • requestFromStandalone<T>(path: string, options?: RequestInit): Promise<T>

reset

  • reset(): Promise<boolean>

start

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

stop

  • stop(): Promise<void>

urlFor

  • urlFor(path: string): string

  • Parameters

    • path: string

    Returns string

Generated using TypeDoc