Class ServerApi

Hierarchy

BaseAPI
- ServerApi

Constructors

constructor

new ServerApi(configuration?): ServerApi
Parameters
- configuration: Configuration = ...
Returns ServerApi
Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

pluginsGet

pluginsGet(): Promise<AdminModules>
Fetch the list of loaded plugins

Returns Promise<AdminModules>
- Defined in client/apis/ServerApi.ts:59

pluginsGetRaw

pluginsGetRaw(): Promise<ApiResponse<AdminModules>>
Fetch the list of loaded plugins

Returns Promise<ApiResponse<AdminModules>>
- Defined in client/apis/ServerApi.ts:39

`Protected` request

request(context): Promise<Response>
Parameters
- context: RequestOpts
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in client/runtime.ts:50

shutdownGet

shutdownGet(): Promise<object>
Shut down server

Returns Promise<object>
- Defined in client/apis/ServerApi.ts:85

shutdownGetRaw

shutdownGetRaw(): Promise<ApiResponse<object>>
Shut down server

Returns Promise<ApiResponse<object>>
- Defined in client/apis/ServerApi.ts:67

statusConfigGet

statusConfigGet(): Promise<AdminConfig>
Fetch the server configuration

Returns Promise<AdminConfig>
- Defined in client/apis/ServerApi.ts:113

statusConfigGetRaw

statusConfigGetRaw(): Promise<ApiResponse<AdminConfig>>
Fetch the server configuration

Returns Promise<ApiResponse<AdminConfig>>
- Defined in client/apis/ServerApi.ts:93

statusGet

statusGet(): Promise<AdminStatus>
Fetch the server status

Returns Promise<AdminStatus>
- Defined in client/apis/ServerApi.ts:141

statusGetRaw

statusGetRaw(): Promise<ApiResponse<AdminStatus>>
Fetch the server status

Returns Promise<ApiResponse<AdminStatus>>
- Defined in client/apis/ServerApi.ts:121

statusLiveGet

statusLiveGet(): Promise<AdminStatusLiveliness>
Liveliness check

Returns Promise<AdminStatusLiveliness>
- Defined in client/apis/ServerApi.ts:171

statusLiveGetRaw

statusLiveGetRaw(): Promise<ApiResponse<AdminStatusLiveliness>>
Liveliness check

Returns Promise<ApiResponse<AdminStatusLiveliness>>
- Defined in client/apis/ServerApi.ts:149

statusReadyGet

statusReadyGet(): Promise<AdminStatusReadiness>
Readiness check

Returns Promise<AdminStatusReadiness>
- Defined in client/apis/ServerApi.ts:201

statusReadyGetRaw

statusReadyGetRaw(): Promise<ApiResponse<AdminStatusReadiness>>
Readiness check

Returns Promise<ApiResponse<AdminStatusReadiness>>
- Defined in client/apis/ServerApi.ts:179

statusResetPost

statusResetPost(): Promise<object>
Reset statistics

Returns Promise<object>
- Defined in client/apis/ServerApi.ts:227

statusResetPostRaw

statusResetPostRaw(): Promise<ApiResponse<object>>
Reset statistics

Returns Promise<ApiResponse<object>>
- Defined in client/apis/ServerApi.ts:209

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...postMiddlewares: (undefined | ((context) => Promise<void | Response>))[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...preMiddlewares: (undefined | ((context) => Promise<void | FetchParams>))[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34

Generated using TypeDoc