Class GeneralService

Hierarchy

GeneralService

Index

Constructors

Properties

Methods

getLedgerInfo healthy spec

Constructors

constructor

new GeneralService(httpRequest: BaseHttpRequest): GeneralService
Parameters
- httpRequest: BaseHttpRequest
Returns GeneralService
- Defined in src/generated/services/GeneralService.ts:12

Properties

`Readonly` httpRequest

httpRequest: BaseHttpRequest

Methods

getLedgerInfo

getLedgerInfo(): CancelablePromise<IndexResponse>
Get ledger info Get the latest ledger information, including data such as chain ID, role type, ledger versions, epoch, etc.

Returns
IndexResponse

Throws
ApiError

Returns CancelablePromise<IndexResponse>
- Defined in src/generated/services/GeneralService.ts:62

healthy

healthy(durationSecs?: number): CancelablePromise<HealthCheckSuccess>
Check basic node health By default this endpoint just checks that it can get the latest ledger info and then returns 200.

If the duration_secs param is provided, this endpoint will return a 200 if the following condition is true:

server_latest_ledger_info_timestamp >= server_current_time_timestamp - duration_secs

Returns
HealthCheckSuccess

Throws
ApiError
Parameters
- Optional durationSecs: number
  
  Threshold in seconds that the server can be behind to be considered healthy
  
  If not provided, the healthcheck will always succeed
Returns CancelablePromise<HealthCheckSuccess>
- Defined in src/generated/services/GeneralService.ts:43

spec

spec(): CancelablePromise<string>
Show OpenAPI explorer Provides a UI that you can use to explore the API. You can also retrieve the API directly at /spec.yaml and /spec.json.

Returns
string

Throws
ApiError

Returns CancelablePromise<string>
- Defined in src/generated/services/GeneralService.ts:21

Generated using TypeDoc