Class MockttpAdminPlugin

This is part of the new 'Pluggable Admin' API.

Everything exported here is experimental, and many change unpredictably in future releases.

Hierarchy

MockttpAdminPlugin

Implements

AdminPlugin<MockttpPluginOptions, MockttpClientResponse>

Index

Constructors

constructor

Properties

schema

Methods

Constructors

constructor

new MockttpAdminPlugin(): MockttpAdminPlugin

Returns MockttpAdminPlugin

Properties

schema

schema: DocumentNode = MockttpSchema

Methods

buildResolvers

buildResolvers(stream: Duplex, ruleParameters: {}): IResolvers<any, any, Record<string, any>, any>

Implementation of AdminPlugin.buildResolvers
- Defined in src/admin/mockttp-admin-plugin.ts:56
Parameters
- stream: Duplex
- ruleParameters: {}
  - [key: string]: any
Returns IResolvers<any, any, Record<string, any>, any>

enableDebug

enableDebug(): void

Implementation of AdminPlugin.enableDebug
- Defined in src/admin/mockttp-admin-plugin.ts:50
Returns void

getMockServer

getMockServer(): MockttpServer

- Defined in src/admin/mockttp-admin-plugin.ts:46
Returns MockttpServer

reset

reset(): void

Implementation of AdminPlugin.reset
- Defined in src/admin/mockttp-admin-plugin.ts:42
Returns void

start

start(__namedParameters: MockttpPluginOptions): Promise<{ mockRoot: string; port: number }>

Implementation of AdminPlugin.start
- Defined in src/admin/mockttp-admin-plugin.ts:28
Parameters
- __namedParameters: MockttpPluginOptions
Returns Promise<{ mockRoot: string; port: number }>

stop

stop(): Promise<void>

Implementation of AdminPlugin.stop
- Defined in src/admin/mockttp-admin-plugin.ts:38
Returns Promise<void>

Generated using TypeDoc