chore: update api (#54)

Author: AuHau

README.md

@@ -71,24 +71,8 @@ SyntaxError: ./bee-js-docs/docs/api/functions/utils.bytes.isbytes.md: Expected c
 Client bundle compiled with errors therefore further build is impossible.
 ```
 
-3. Fix the issues - use the following bash script
-```sh
-# Escape all unescaped '>' characters except for the lines starting with "title:"
-for file in `find ./docs/api`; do 
-    if [ -f "$file" ]; then 
-        mv "$file" "$file.back"
-        sed -e '/^title:/n;s/\([^\\]\)\>/\1\\\>/g' "$file.back" &> "$file"
-        if [ $? -eq 0 ]; then
-            rm "$file.back"
-            echo "fixed: $file"
-        else
-            mv "$file.back" "$file"
-            echo "error: $file"
-        fi
-    fi 
-done
-```
-
+3. Fix the issues - run the `escape-chars.bash` script
+   
 4. In the `docusaurus.config.js` and comment the line 9 with `'docusaurus-plugin-typedoc'` in the plugins array so that the building no longer runs typedoc on `bee-js`. Test the page with `npm run start` or `npm run build` and create PR with this updated API reference.
 
 ## Maintainers

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/0ac3a7d/src/utils/error.ts#L7)
+Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/ce4d3fa/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/0ac3a7d/src/bee-debug.ts#L36)
+Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/ce4d3fa/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/0ac3a7d/src/bee-debug.ts#L36)
+Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L36)
 
 ## Methods
 
@@ -52,7 +52,7 @@ 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/0ac3a7d/src/bee-debug.ts#L161)
+Defined in: [bee-js/src/bee-debug.ts:161](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L161)
 
 ___
 
@@ -70,7 +70,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:170](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L170)
+Defined in: [bee-js/src/bee-debug.ts:170](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L170)
 
 ___
 
@@ -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/0ac3a7d/src/bee-debug.ts#L81)
+Defined in: [bee-js/src/bee-debug.ts:81](https://github.com/ethersphere/bee-js/blob/ce4d3fa/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/0ac3a7d/src/bee-debug.ts#L207)
+Defined in: [bee-js/src/bee-debug.ts:207](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L207)
 
 ___
 
@@ -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/0ac3a7d/src/bee-debug.ts#L51)
+Defined in: [bee-js/src/bee-debug.ts:51](https://github.com/ethersphere/bee-js/blob/ce4d3fa/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/0ac3a7d/src/bee-debug.ts#L120)
+Defined in: [bee-js/src/bee-debug.ts:120](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L120)
 
 ___
 
@@ -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/0ac3a7d/src/bee-debug.ts#L127)
+Defined in: [bee-js/src/bee-debug.ts:127](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L127)
 
 ___
 
@@ -143,7 +143,7 @@ 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/0ac3a7d/src/bee-debug.ts#L214)
+Defined in: [bee-js/src/bee-debug.ts:214](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L214)
 
 ___
 
@@ -161,7 +161,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*LastCashoutActionResponse*](../interfaces/lastcashoutactionresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:152](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L152)
+Defined in: [bee-js/src/bee-debug.ts:152](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L152)
 
 ___
 
@@ -173,7 +173,7 @@ 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/0ac3a7d/src/bee-debug.ts#L134)
+Defined in: [bee-js/src/bee-debug.ts:134](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L134)
 
 ___
 
@@ -191,7 +191,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*LastChequesForPeerResponse*](../interfaces/lastchequesforpeerresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:143](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L143)
+Defined in: [bee-js/src/bee-debug.ts:143](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L143)
 
 ___
 
@@ -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/0ac3a7d/src/bee-debug.ts#L47)
+Defined in: [bee-js/src/bee-debug.ts:47](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L47)
 
 ___
 
@@ -213,7 +213,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:97](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L97)
+Defined in: [bee-js/src/bee-debug.ts:97](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L97)
 
 ___
 
@@ -231,7 +231,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:106](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L106)
+Defined in: [bee-js/src/bee-debug.ts:106](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L106)
 
 ___
 
@@ -249,7 +249,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/0ac3a7d/src/bee-debug.ts#L90)
+Defined in: [bee-js/src/bee-debug.ts:90](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L90)
 
 ___
 
@@ -261,7 +261,7 @@ 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/0ac3a7d/src/bee-debug.ts#L58)
+Defined in: [bee-js/src/bee-debug.ts:58](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L58)
 
 ___
 
@@ -279,7 +279,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*Settlements*](../interfaces/settlements.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:200](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L200)
+Defined in: [bee-js/src/bee-debug.ts:200](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L200)
 
 ___
 
@@ -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/0ac3a7d/src/bee-debug.ts#L66)
+Defined in: [bee-js/src/bee-debug.ts:66](https://github.com/ethersphere/bee-js/blob/ce4d3fa/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/0ac3a7d/src/bee-debug.ts#L223)
+Defined in: [bee-js/src/bee-debug.ts:223](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L223)
 
 ___
 
@@ -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/0ac3a7d/src/bee-debug.ts#L70)
+Defined in: [bee-js/src/bee-debug.ts:70](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L70)
 
 ___
 
@@ -335,7 +335,7 @@ Name | Type |
 
 **Returns:** *Promise*<[*RemovePeerResponse*](../interfaces/removepeerresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:62](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L62)
+Defined in: [bee-js/src/bee-debug.ts:62](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L62)
 
 ___
 
@@ -353,4 +353,4 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:183](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L183)
+Defined in: [bee-js/src/bee-debug.ts:183](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/bee-debug.ts#L183)

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/0ac3a7d/src/utils/error.ts#L1)
+Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/ce4d3fa/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/0ac3a7d/src/utils/error.ts#L13)
+Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/ce4d3fa/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/0ac3a7d/src/utils/error.ts#L19)
+Defined in: [bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/utils/error.ts#L19)
 
 ## Properties
 

docs/api/classes/beerequesterror.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/0ac3a7d/src/utils/bytes.ts#L91)
+Defined in: [bee-js/src/utils/bytes.ts:91](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/utils/bytes.ts#L91)

docs/api/classes/beeresponseerror.md

@@ -23,4 +23,4 @@ Name | Type | Description |
 
 **Returns:** *boolean*
 
-Defined in: [bee-js/src/utils/bytes.ts:118](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/bytes.ts#L118)
+Defined in: [bee-js/src/utils/bytes.ts:118](https://github.com/ethersphere/bee-js/blob/ce4d3fa/src/utils/bytes.ts#L118)