Class AdminClient<Plugins>

A bare admin server client. This is not intended for general use, but can be useful when building admin server plugins to mock non-HTTP protocols and other advanced use cases.

For normal usage of Mockttp, you should use Mockttp.getRemote() instead, to get a Mockttp remote client, which wraps this class with the full Mockttp API for mocking HTTP.

This is part of Mockttp's experimental 'pluggable admin' API. It may change unpredictably, even in minor releases.

Type Parameters

Plugins extends { [key: string]: AdminPlugin<any, any> }

Hierarchy

EventEmitter
- AdminClient

Index

Constructors

constructor

new AdminClient<Plugins extends { [key: string]: AdminPlugin<any, any> }>(
options?: AdminClientOptions,
): AdminClient<Plugins>
Type Parameters
- Plugins extends { [key: string]: AdminPlugin<any, any> }
Parameters
- options: AdminClientOptions = {}
Returns AdminClient<Plugins>
Overrides EventEmitter.constructor
- Defined in client/admin-client.ts:218

Accessors

adminStream

get adminStream(): Duplex
Returns Duplex
- Defined in client/admin-client.ts:513

metadata

get metadata(): PluginClientResponsesMap<Plugins>
Returns PluginClientResponsesMap<Plugins>
- Defined in client/admin-client.ts:503

schema

get schema(): SchemaIntrospector
Returns SchemaIntrospector
- Defined in client/admin-client.ts:508

Methods

enableDebug

enableDebug(): Promise<void>
Returns Promise<void>
- Defined in client/admin-client.ts:567

getRuleParameterKeys

getRuleParameterKeys(): Promise<string[]>
List the names of the rule parameters defined by the admin server. This can be used in some advanced use cases to confirm that the parameters a client wishes to reference are available.

Only defined for remote clients.

Returns Promise<string[]>
- Defined in client/admin-client.ts:653

isRunning

isRunning(): boolean
Returns boolean
- Defined in client/admin-client.ts:499

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in client/admin-client.ts:576

sendQueries

sendQueries<Queries extends AdminQuery<any, any>[]>(
    ...queries: [...Queries[]],
): Promise<
    {
        [n in string
        | number
        | symbol]: Queries[n] extends AdminQuery<any, R> ? R : never
    },
>
Type Parameters
- Queries extends AdminQuery<any, any>[]
Parameters
- ...queries: [...Queries[]]
Returns Promise<
    {
        [n in string
        | number
        | symbol]: Queries[n] extends AdminQuery<any, R> ? R : never
    },
>
- Defined in client/admin-client.ts:588

sendQuery

sendQuery<Response, Result = Response>(
query: AdminQuery<Response, Result>,
): Promise<Result>
Type Parameters
- Response
- Result = Response
Parameters
- query: AdminQuery<Response, Result>
Returns Promise<Result>
- Defined in client/admin-client.ts:584

start

start(
pluginStartParams: PluginStartParamsMap<Plugins>,
): Promise<PluginClientResponsesMap<Plugins>>
Parameters
- pluginStartParams: PluginStartParamsMap<Plugins>
Returns Promise<PluginClientResponsesMap<Plugins>>
- Defined in client/admin-client.ts:423

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in client/admin-client.ts:520

subscribe<Response, Result = Response>(
query: AdminQuery<Response, Result>,
callback: (data: Result) => void,
): Promise<void>
Type Parameters
- Response
- Result = Response
Parameters
- query: AdminQuery<Response, Result>
- callback: (data: Result) => void
Returns Promise<void>
- Defined in client/admin-client.ts:605

Class AdminClient<Plugins>

Type Parameters

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AdminClient<Plugins>

Accessors

adminStream

Returns Duplex

metadata

Returns PluginClientResponsesMap<Plugins>

schema

Returns SchemaIntrospector

Methods

enableDebug

Returns Promise<void>

getRuleParameterKeys

Returns Promise<string[]>

isRunning

Returns boolean

reset

Returns Promise<void>

sendQueries

Type Parameters

Parameters

Returns Promise< { [n in string | number | symbol]: Queries[n] extends AdminQuery<any, R> ? R : never },>

sendQuery

Type Parameters

Parameters

Returns Promise<Result>

start

Parameters

Returns Promise<PluginClientResponsesMap<Plugins>>

stop

Returns Promise<void>

subscribe

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page

Returns Promise<
{
[n in string
| number
| symbol]: Queries[n] extends AdminQuery<any, R> ? R : never
},
>