MockttpAdminServer | mockttp

MockttpAdminServer | mockttp

Hierarchy (view full)

AdminServer<{
http: MockttpAdminPlugin;
}>
- MockttpAdminServer

Index

Constructors

constructor

new MockttpAdminServer(options): MockttpAdminServer
Returns MockttpAdminServer

Accessors

ruleParameterKeys

get ruleParameterKeys(): string[]
Returns string[]

Methods

on

on(event, listener): void
Parameters
- event: "mock-session-started"
- listener: ((plugins: {
  http: MockttpAdminPlugin;
  }, sessionId: string) => void)
  - - (plugins, sessionId): void
    - Parameters
      plugins: {
      http: MockttpAdminPlugin;
      }
      http: MockttpAdminPlugin
      sessionId: string
      Returns void
Returns void
on(event, listener): void
Parameters
- event: "mock-session-stopping"
- listener: ((plugins: {
  http: MockttpAdminPlugin;
  }, sessionId: string) => void)
  - - (plugins, sessionId): void
    - Parameters
      plugins: {
      http: MockttpAdminPlugin;
      }
      http: MockttpAdminPlugin
      sessionId: string
      Returns void
Returns void

resetAdminServer

resetAdminServer(): Promise<void>
Returns Promise<void>

start

start(listenOptions?): Promise<void>
Parameters
- listenOptions: number | {
  host: string;
  port: number;
  } = DEFAULT_ADMIN_SERVER_PORT
Returns Promise<void>

stop

stop(): Promise<void>
Returns Promise<void>