feat: bee-js 0.9.0 api reference (#60)

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/9a547fe/src/utils/error.ts#L7)
+Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/error.ts#L7)
 
 ## Properties
 

docs/api/classes/bee.md

@@ -26,15 +26,15 @@ Name | Type |
 
 **Returns:** [*BeeDebug*](beedebug.md)
 
-Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L36)
+Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L36)
 
 ## Properties
 
 ### url
 
 • `Readonly` **url**: *string*
 
-Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L36)
+Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L36)
 
 ## Methods
 
@@ -52,25 +52,25 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*CashoutResponse*](../interfaces/cashoutresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:161](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L161)
+Defined in: [bee-js/src/bee-debug.ts:169](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L169)
 
 ___
 
 ### depositTokens
 
-▸ **depositTokens**(`amount`: *number* \| BigInt): *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
+▸ **depositTokens**(`amount`: *number* \| *bigint*): *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
 
 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)    |
 
 **Returns:** *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:170](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L170)
+Defined in: [bee-js/src/bee-debug.ts:178](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L178)
 
 ___
 
@@ -82,7 +82,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/9a547fe/src/bee-debug.ts#L81)
+Defined in: [bee-js/src/bee-debug.ts:81](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L81)
 
 ___
 
@@ -94,7 +94,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:207](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L207)
+Defined in: [bee-js/src/bee-debug.ts:217](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L217)
 
 ___
 
@@ -104,7 +104,7 @@ ___
 
 **Returns:** *Promise*<[*Peer*](../interfaces/peer.md)[]\>
 
-Defined in: [bee-js/src/bee-debug.ts:51](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L51)
+Defined in: [bee-js/src/bee-debug.ts:51](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L51)
 
 ___
 
@@ -119,7 +119,7 @@ https://github.com/ethersphere/bee/issues/1443
 
 **Returns:** *Promise*<[*ChequebookAddressResponse*](../interfaces/chequebookaddressresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:120](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L120)
+Defined in: [bee-js/src/bee-debug.ts:124](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L124)
 
 ___
 
@@ -131,7 +131,7 @@ Get the balance of the chequebook
 
 **Returns:** *Promise*<[*ChequebookBalanceResponse*](../interfaces/chequebookbalanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:127](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L127)
+Defined in: [bee-js/src/bee-debug.ts:131](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L131)
 
 ___
 
@@ -143,25 +143,25 @@ Get health of node
 
 **Returns:** *Promise*<[*Health*](../interfaces/health.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:214](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L214)
+Defined in: [bee-js/src/bee-debug.ts:224](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L224)
 
 ___
 
 ### getLastCashoutAction
 
-▸ **getLastCashoutAction**(`address`: *string*): *Promise*<[*LastCashoutActionResponse*](../interfaces/lastcashoutactionresponse.md)\>
+▸ **getLastCashoutAction**(`address`: *string* \| [*Address*](../types/address.md)): *Promise*<[*LastCashoutActionResponse*](../interfaces/lastcashoutactionresponse.md)\>
 
 Get last cashout action for the peer
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`address` | *string* | Swarm address of peer    |
+`address` | *string* \| [*Address*](../types/address.md) | Swarm address of peer    |
 
 **Returns:** *Promise*<[*LastCashoutActionResponse*](../interfaces/lastcashoutactionresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:152](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L152)
+Defined in: [bee-js/src/bee-debug.ts:158](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L158)
 
 ___
 
@@ -173,25 +173,25 @@ Get last cheques for all peers
 
 **Returns:** *Promise*<[*LastChequesResponse*](../interfaces/lastchequesresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:134](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L134)
+Defined in: [bee-js/src/bee-debug.ts:138](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L138)
 
 ___
 
 ### getLastChequesForPeer
 
-▸ **getLastChequesForPeer**(`address`: *string*): *Promise*<[*LastChequesForPeerResponse*](../interfaces/lastchequesforpeerresponse.md)\>
+▸ **getLastChequesForPeer**(`address`: *string* \| [*Address*](../types/address.md)): *Promise*<[*LastChequesForPeerResponse*](../interfaces/lastchequesforpeerresponse.md)\>
 
 Get last cheques for the peer
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`address` | *string* | Swarm address of peer    |
+`address` | *string* \| [*Address*](../types/address.md) | Swarm address of peer    |
 
 **Returns:** *Promise*<[*LastChequesForPeerResponse*](../interfaces/lastchequesforpeerresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:143](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L143)
+Defined in: [bee-js/src/bee-debug.ts:147](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L147)
 
 ___
 
@@ -201,7 +201,7 @@ ___
 
 **Returns:** *Promise*<[*NodeAddresses*](../interfaces/nodeaddresses.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:47](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L47)
+Defined in: [bee-js/src/bee-debug.ts:47](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L47)
 
 ___
 
@@ -213,43 +213,43 @@ Get the past due consumption balances with all known peers
 
 **Returns:** *Promise*<[*BalanceResponse*](../interfaces/balanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:97](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L97)
+Defined in: [bee-js/src/bee-debug.ts:99](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L99)
 
 ___
 
 ### getPastDueConsumptionPeerBalance
 
-▸ **getPastDueConsumptionPeerBalance**(`address`: *string*): *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
+▸ **getPastDueConsumptionPeerBalance**(`address`: *string* \| [*Address*](../types/address.md)): *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
 Get the past due consumption balance with a specific peer
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`address` | *string* | Swarm address of peer    |
+`address` | *string* \| [*Address*](../types/address.md) | Swarm address of peer    |
 
 **Returns:** *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:106](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L106)
+Defined in: [bee-js/src/bee-debug.ts:108](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L108)
 
 ___
 
 ### getPeerBalance
 
-▸ **getPeerBalance**(`address`: *string*): *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
+▸ **getPeerBalance**(`address`: *string* \| [*Address*](../types/address.md)): *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
 Get the balances with a specific peer including prepaid services
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`address` | *string* | Swarm address of peer    |
+`address` | *string* \| [*Address*](../types/address.md) | Swarm address of peer    |
 
 **Returns:** *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:90](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L90)
+Defined in: [bee-js/src/bee-debug.ts:90](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L90)
 
 ___
 
@@ -261,25 +261,25 @@ 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/9a547fe/src/bee-debug.ts#L58)
+Defined in: [bee-js/src/bee-debug.ts:58](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L58)
 
 ___
 
 ### getSettlements
 
-▸ **getSettlements**(`address`: *string*): *Promise*<[*Settlements*](../interfaces/settlements.md)\>
+▸ **getSettlements**(`address`: *string* \| [*Address*](../types/address.md)): *Promise*<[*Settlements*](../interfaces/settlements.md)\>
 
 Get amount of sent and received from settlements with a peer
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`address` | *string* | Swarm address of peer    |
+`address` | *string* \| [*Address*](../types/address.md) | Swarm address of peer    |
 
 **Returns:** *Promise*<[*Settlements*](../interfaces/settlements.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:200](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L200)
+Defined in: [bee-js/src/bee-debug.ts:208](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L208)
 
 ___
 
@@ -289,7 +289,7 @@ ___
 
 **Returns:** *Promise*<[*Topology*](../interfaces/topology.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:66](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L66)
+Defined in: [bee-js/src/bee-debug.ts:66](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L66)
 
 ___
 
@@ -303,7 +303,7 @@ 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:223](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L223)
+Defined in: [bee-js/src/bee-debug.ts:233](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L233)
 
 ___
 
@@ -319,7 +319,7 @@ Name | Type |
 
 **Returns:** *Promise*<[*PingResponse*](../interfaces/pingresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:70](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L70)
+Defined in: [bee-js/src/bee-debug.ts:70](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L70)
 
 ___
 
@@ -335,22 +335,22 @@ Name | Type |
 
 **Returns:** *Promise*<[*RemovePeerResponse*](../interfaces/removepeerresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:62](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L62)
+Defined in: [bee-js/src/bee-debug.ts:62](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L62)
 
 ___
 
 ### withdrawTokens
 
-▸ **withdrawTokens**(`amount`: *number* \| BigInt): *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
+▸ **withdrawTokens**(`amount`: *number* \| *bigint*): *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
 
 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)    |
 
 **Returns:** *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:183](https://github.com/ethersphere/bee-js/blob/9a547fe/src/bee-debug.ts#L183)
+Defined in: [bee-js/src/bee-debug.ts:191](https://github.com/ethersphere/bee-js/blob/7260ee1/src/bee-debug.ts#L191)

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/9a547fe/src/utils/error.ts#L1)
+Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/7260ee1/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/9a547fe/src/utils/error.ts#L13)
+Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/7260ee1/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/9a547fe/src/utils/error.ts#L19)
+Defined in: [bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/7260ee1/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/9a547fe/src/utils/bytes.ts#L44)
+Defined in: [bee-js/src/utils/bytes.ts:44](https://github.com/ethersphere/bee-js/blob/7260ee1/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/9a547fe/src/utils/bytes.ts#L72)
+Defined in: [bee-js/src/utils/bytes.ts:72](https://github.com/ethersphere/bee-js/blob/7260ee1/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/9a547fe/src/utils/bytes.ts#L91)
+Defined in: [bee-js/src/utils/bytes.ts:91](https://github.com/ethersphere/bee-js/blob/7260ee1/src/utils/bytes.ts#L91)