Module "apis/index"

Index

Interfaces

Type aliases

ImportApiErrorsArgument

Variables

API_ERRORS

Functions

Type aliases

ImportApiErrorsArgument

ImportApiErrorsArgument: string | Buffer | ApiErrorWithKey | ApiErrorWithKey[]

A possible value for 'importApiErrors()' and 'importApiErrorsSync()' functions.

If STRING: The path to the JSON file to import. If BUFFER: The binary content as UTF-8 JSON data. If OBJECT or ARRAY: One or more items to import.

Variables

Const API_ERRORS

API_ERRORS: {}

Global list of API errors.

Type declaration

[name: string]: ApiError

Functions

applyApiErrors

applyApiErrors(errors: ApiErrorWithKey[]): void

- Defined in src/apis/index.ts:178
Parameters
- errors: ApiErrorWithKey[]
Returns void

createMonitoringApiResult

createMonitoringApiResult(opts?: CreateMonitoringApiResultOptions): Promise<MonitoringApiResult>

- Defined in src/apis/index.ts:198
Creates an object for an result of a monitoring API endpoint.

Parameters
- Optional opts: CreateMonitoringApiResultOptions
Returns Promise<MonitoringApiResult>

The promise with the result (object).

importApiErrors

importApiErrors(errors: ImportApiErrorsArgument): Promise<void>

- Defined in src/apis/index.ts:320
Imports the data for 'API_ERRORS' constant.

Parameters
- errors: ImportApiErrorsArgument
  
  The items to import.
Returns Promise<void>

importApiErrorsSync

importApiErrorsSync(errors: ImportApiErrorsArgument): void

- Defined in src/apis/index.ts:348
Imports the data for 'API_ERRORS' constant (sync).

Parameters
- errors: ImportApiErrorsArgument
  
  The items to import.
Returns void

sendResponse

sendResponse(res: Response, result: ApiResult, opts?: SendResponseOptions): Response

- Defined in src/apis/index.ts:380
Sends an API response.

Parameters
- res: Response
  
  The response context.
- result: ApiResult
  
  The result context.
- Optional opts: SendResponseOptions
Returns Response

The current response context.

Generated using TypeDoc