feat: bee-js 0.11.0 api reference (#63)

Author: AuHau

bee-js

@@ -31,7 +31,7 @@ Name | Type |
 
 Inherited from: [BeeError](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/error.ts#L7)
+Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/error.ts#L7)
 
 ## Properties
 

docs/api/classes/bee.md

@@ -26,51 +26,55 @@ Name | Type |
 
 **Returns:** [*BeeDebug*](beedebug.md)
 
-Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L36)
+Defined in: [bee-js/src/bee-debug.ts:37](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L37)
 
 ## Properties
 
 ### url
 
 • `Readonly` **url**: *string*
 
-Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L36)
+Defined in: [bee-js/src/bee-debug.ts:37](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L37)
 
 ## Methods
 
 ### cashoutLastCheque
 
-▸ **cashoutLastCheque**(`address`: *string*): *Promise*<[*CashoutResponse*](../interfaces/cashoutresponse.md)\>
+▸ **cashoutLastCheque**(`address`: *string* \| [*Address*](../types/address.md), `options?`: [*CashoutOptions*](../interfaces/cashoutoptions.md)): *Promise*<string\>
 
 Cashout the last cheque for the peer
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`address` | *string* | Swarm address of peer    |
+`address` | *string* \| [*Address*](../types/address.md) | Swarm address of peer   |
+`options?` | [*CashoutOptions*](../interfaces/cashoutoptions.md) |  |
 
-**Returns:** *Promise*<[*CashoutResponse*](../interfaces/cashoutresponse.md)\>
+**Returns:** *Promise*<string\>
 
-Defined in: [bee-js/src/bee-debug.ts:169](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L169)
+Defined in: [bee-js/src/bee-debug.ts:177](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L177)
 
 ___
 
 ### depositTokens
 
-▸ **depositTokens**(`amount`: *number* \| *bigint*): *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
+▸ **depositTokens**(`amount`: *number* \| *bigint*, `gasPrice?`: *bigint*): *Promise*<string\>
 
 Deposit tokens from overlay address into chequebook
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`amount` | *number* \| *bigint* | Amount of tokens to deposit (must be positive integer)    |
+`amount` | *number* \| *bigint* | Amount of tokens to deposit (must be positive integer)   |
+`gasPrice?` | *bigint* | Gas Price in WEI for the transaction call   |
 
-**Returns:** *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
+**Returns:** *Promise*<string\>
 
-Defined in: [bee-js/src/bee-debug.ts:178](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L178)
+string  Hash of the transaction
+
+Defined in: [bee-js/src/bee-debug.ts:198](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L198)
 
 ___
 
@@ -82,7 +86,7 @@ Get the balances with all known peers including prepaid services
 
 **Returns:** *Promise*<[*BalanceResponse*](../interfaces/balanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:81](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L81)
+Defined in: [bee-js/src/bee-debug.ts:86](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L86)
 
 ___
 
@@ -94,7 +98,7 @@ Get settlements with all known peers and total amount sent or received
 
 **Returns:** *Promise*<[*AllSettlements*](../interfaces/allsettlements.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:217](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L217)
+Defined in: [bee-js/src/bee-debug.ts:243](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L243)
 
 ___
 
@@ -104,7 +108,19 @@ ___
 
 **Returns:** *Promise*<[*Peer*](../interfaces/peer.md)[]\>
 
-Defined in: [bee-js/src/bee-debug.ts:51](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L51)
+Defined in: [bee-js/src/bee-debug.ts:52](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L52)
+
+___
+
+### getChainState
+
+▸ **getChainState**(): *Promise*<[*ChainState*](../interfaces/chainstate.md)\>
+
+Get chain state
+
+**Returns:** *Promise*<[*ChainState*](../interfaces/chainstate.md)\>
+
+Defined in: [bee-js/src/bee-debug.ts:273](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L273)
 
 ___
 
@@ -119,7 +135,7 @@ https://github.com/ethersphere/bee/issues/1443
 
 **Returns:** *Promise*<[*ChequebookAddressResponse*](../interfaces/chequebookaddressresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:124](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L124)
+Defined in: [bee-js/src/bee-debug.ts:129](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L129)
 
 ___
 
@@ -131,7 +147,7 @@ Get the balance of the chequebook
 
 **Returns:** *Promise*<[*ChequebookBalanceResponse*](../interfaces/chequebookbalanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:131](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L131)
+Defined in: [bee-js/src/bee-debug.ts:136](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L136)
 
 ___
 
@@ -143,7 +159,7 @@ Get health of node
 
 **Returns:** *Promise*<[*Health*](../interfaces/health.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:224](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L224)
+Defined in: [bee-js/src/bee-debug.ts:250](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L250)
 
 ___
 
@@ -161,7 +177,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*LastCashoutActionResponse*](../interfaces/lastcashoutactionresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:158](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L158)
+Defined in: [bee-js/src/bee-debug.ts:163](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L163)
 
 ___
 
@@ -173,7 +189,7 @@ Get last cheques for all peers
 
 **Returns:** *Promise*<[*LastChequesResponse*](../interfaces/lastchequesresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:138](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L138)
+Defined in: [bee-js/src/bee-debug.ts:143](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L143)
 
 ___
 
@@ -191,7 +207,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*LastChequesForPeerResponse*](../interfaces/lastchequesforpeerresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:147](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L147)
+Defined in: [bee-js/src/bee-debug.ts:152](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L152)
 
 ___
 
@@ -201,7 +217,7 @@ ___
 
 **Returns:** *Promise*<[*NodeAddresses*](../interfaces/nodeaddresses.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:47](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L47)
+Defined in: [bee-js/src/bee-debug.ts:48](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L48)
 
 ___
 
@@ -213,7 +229,7 @@ Get the past due consumption balances with all known peers
 
 **Returns:** *Promise*<[*BalanceResponse*](../interfaces/balanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:99](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L99)
+Defined in: [bee-js/src/bee-debug.ts:104](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L104)
 
 ___
 
@@ -231,7 +247,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:108](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L108)
+Defined in: [bee-js/src/bee-debug.ts:113](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L113)
 
 ___
 
@@ -249,7 +265,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:90](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L90)
+Defined in: [bee-js/src/bee-debug.ts:95](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L95)
 
 ___
 
@@ -261,7 +277,19 @@ Get list of peers for this node
 
 **Returns:** *Promise*<[*Peer*](../interfaces/peer.md)[]\>
 
-Defined in: [bee-js/src/bee-debug.ts:58](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L58)
+Defined in: [bee-js/src/bee-debug.ts:59](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L59)
+
+___
+
+### getReserveState
+
+▸ **getReserveState**(): *Promise*<[*ReserveState*](../interfaces/reservestate.md)\>
+
+Get reserve state
+
+**Returns:** *Promise*<[*ReserveState*](../interfaces/reservestate.md)\>
+
+Defined in: [bee-js/src/bee-debug.ts:266](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L266)
 
 ___
 
@@ -279,7 +307,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*Settlements*](../interfaces/settlements.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:208](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L208)
+Defined in: [bee-js/src/bee-debug.ts:234](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L234)
 
 ___
 
@@ -289,7 +317,7 @@ ___
 
 **Returns:** *Promise*<[*Topology*](../interfaces/topology.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:66](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L66)
+Defined in: [bee-js/src/bee-debug.ts:69](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L69)
 
 ___
 
@@ -303,54 +331,57 @@ Connnects to a node and checks if it is a supported Bee version by the bee-js
 
 true if the Bee node version is supported
 
-Defined in: [bee-js/src/bee-debug.ts:233](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L233)
+Defined in: [bee-js/src/bee-debug.ts:259](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L259)
 
 ___
 
 ### pingPeer
 
-▸ **pingPeer**(`peer`: *string*): *Promise*<[*PingResponse*](../interfaces/pingresponse.md)\>
+▸ **pingPeer**(`peer`: *string* \| [*Address*](../types/address.md)): *Promise*<[*PingResponse*](../interfaces/pingresponse.md)\>
 
 #### Parameters:
 
 Name | Type |
 :------ | :------ |
-`peer` | *string* |
+`peer` | *string* \| [*Address*](../types/address.md) |
 
 **Returns:** *Promise*<[*PingResponse*](../interfaces/pingresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:70](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L70)
+Defined in: [bee-js/src/bee-debug.ts:73](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L73)
 
 ___
 
 ### removePeer
 
-▸ **removePeer**(`peer`: *string*): *Promise*<[*RemovePeerResponse*](../interfaces/removepeerresponse.md)\>
+▸ **removePeer**(`peer`: *string* \| [*Address*](../types/address.md)): *Promise*<[*RemovePeerResponse*](../interfaces/removepeerresponse.md)\>
 
 #### Parameters:
 
 Name | Type |
 :------ | :------ |
-`peer` | *string* |
+`peer` | *string* \| [*Address*](../types/address.md) |
 
 **Returns:** *Promise*<[*RemovePeerResponse*](../interfaces/removepeerresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:62](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L62)
+Defined in: [bee-js/src/bee-debug.ts:63](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L63)
 
 ___
 
 ### withdrawTokens
 
-▸ **withdrawTokens**(`amount`: *number* \| *bigint*): *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
+▸ **withdrawTokens**(`amount`: *number* \| *bigint*, `gasPrice?`: *bigint*): *Promise*<string\>
 
 Withdraw tokens from the chequebook to the overlay address
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`amount` | *number* \| *bigint* | Amount of tokens to withdraw (must be positive integer)    |
+`amount` | *number* \| *bigint* | Amount of tokens to withdraw (must be positive integer)   |
+`gasPrice?` | *bigint* | Gas Price in WEI for the transaction call   |
+
+**Returns:** *Promise*<string\>
 
-**Returns:** *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
+string  Hash of the transaction
 
-Defined in: [bee-js/src/bee-debug.ts:191](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L191)
+Defined in: [bee-js/src/bee-debug.ts:215](https://github.com/ethersphere/bee-js/blob/430becc/src/bee-debug.ts#L215)

docs/api/classes/beeargumenterror.md

@@ -34,7 +34,7 @@ Name | Type |
 
 **Returns:** [*BeeError*](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/error.ts#L1)
+Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/error.ts#L1)
 
 ## Properties
 

docs/api/classes/beedebug.md

@@ -30,7 +30,7 @@ Name | Type |
 
 Inherited from: [BeeError](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/error.ts#L13)
+Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/error.ts#L13)
 
 ## Properties
 

docs/api/classes/beeerror.md

@@ -31,7 +31,7 @@ Name | Type |
 
 Inherited from: [BeeError](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/error.ts#L19)
+Defined in: [bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/error.ts#L19)
 
 ## Properties
 

docs/api/classes/beerequesterror.md

@@ -29,4 +29,4 @@ Name | Type | Description |
 
 **Returns:** asserts b is Bytes<Length\>
 
-Defined in: [bee-js/src/utils/bytes.ts:44](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/bytes.ts#L44)
+Defined in: [bee-js/src/utils/bytes.ts:44](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/bytes.ts#L44)

docs/api/classes/beeresponseerror.md

@@ -31,4 +31,4 @@ Name | Type | Description |
 
 **Returns:** asserts b is FlexBytes<Min, Max\>
 
-Defined in: [bee-js/src/utils/bytes.ts:72](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/bytes.ts#L72)
+Defined in: [bee-js/src/utils/bytes.ts:72](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/bytes.ts#L72)

docs/api/functions/utils.bytes.assertbytes.md

@@ -30,4 +30,4 @@ Name | Type | Description |
 
 **Returns:** [*Bytes*](../interfaces/utils.bytes.bytes.md)<Length\>
 
-Defined in: [bee-js/src/utils/bytes.ts:91](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/bytes.ts#L91)
+Defined in: [bee-js/src/utils/bytes.ts:91](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/bytes.ts#L91)