Class: Status
Defined in: bee-js/src/modules/status.ts:13
Node status, health, version and chain/reserve state operations.
Accessed as bee.status.
Constructors
Constructor
new Status(
context):Status
Defined in: bee-js/src/modules/status.ts:14
Parameters
context
BeeContext
Returns
Status
Methods
get()
get(
requestOptions?):Promise<DebugStatus>
Defined in: bee-js/src/modules/status.ts:21
Gets the general status of the node.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<DebugStatus>
getChainState()
getChainState(
requestOptions?):Promise<ChainState>
Defined in: bee-js/src/modules/status.ts:107
Gets chain state.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<ChainState>
getHealth()
getHealth(
requestOptions?):Promise<Health>
Defined in: bee-js/src/modules/status.ts:30
Gets the health of the node.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<Health>
getNodeInfo()
getNodeInfo(
requestOptions?):Promise<NodeInfo>
Defined in: bee-js/src/modules/status.ts:48
Gets mode information of the node.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<NodeInfo>
getReadiness()
getReadiness(
requestOptions?):Promise<Readiness>
Defined in: bee-js/src/modules/status.ts:39
Gets the readiness status of the node.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<Readiness>
getReserveState()
getReserveState(
requestOptions?):Promise<ReserveState>
Defined in: bee-js/src/modules/status.ts:98
Gets reserve state.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<ReserveState>
getVersions()
getVersions(
requestOptions?):Promise<BeeVersions>
Defined in: bee-js/src/modules/status.ts:82
Returns object with all versions specified by the connected Bee node (properties prefixed with bee*)
and versions that bee-js supports (properties prefixed with supported*).
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<BeeVersions>
isSupportedApiVersion()
isSupportedApiVersion(
requestOptions?):Promise<boolean>
Defined in: bee-js/src/modules/status.ts:70
Connects to a node and checks if its Main API version matches with the one that bee-js supports.
This should be the main way how to check compatibility for your app and Bee node.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<boolean>
isSupportedExactVersion()
isSupportedExactVersion(
requestOptions?):Promise<boolean>
Defined in: bee-js/src/modules/status.ts:57
Connects to a node and checks if its version matches with the one that bee-js supports.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<boolean>