diff --git a/bee-js b/bee-js index 6f227e11..74056cb8 160000 --- a/bee-js +++ b/bee-js @@ -1 +1 @@ -Subproject commit 6f227e117b805cfcb12a5d6ec9a17f69a0d27f03 +Subproject commit 74056cb854869d917562dbd747427815a48e1079 diff --git a/docs/api/classes/bee.md b/docs/api/classes/bee.md index 768fca9d..c2f2ac55 100644 --- a/docs/api/classes/bee.md +++ b/docs/api/classes/bee.md @@ -26,7 +26,7 @@ For example gateway mode and light node mode has only limited set of endpoints e #### Defined in -[bee-js/src/bee.ts:85](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L85) +[bee-js/src/bee.ts:86](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L86) ## Properties @@ -38,7 +38,7 @@ Default Signer object used for signing operations, mainly Feeds. #### Defined in -[bee-js/src/bee.ts:85](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L85) +[bee-js/src/bee.ts:86](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L86) ___ @@ -50,7 +50,7 @@ URL on which is the main API of Bee node exposed #### Defined in -[bee-js/src/bee.ts:80](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L80) +[bee-js/src/bee.ts:81](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L81) ## Methods @@ -68,7 +68,7 @@ Ping the Bee node to see if there is a live Bee node on the given URL. #### Defined in -[bee-js/src/bee.ts:902](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L902) +[bee-js/src/bee.ts:906](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L906) ___ @@ -99,7 +99,7 @@ Feed manifest chunk allows for a feed to be able to be resolved through `/bzz` e #### Defined in -[bee-js/src/bee.ts:644](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L644) +[bee-js/src/bee.ts:645](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L645) ___ @@ -123,6 +123,8 @@ For better understanding what each parameter means and what are the optimal valu **`see`** [Bee API reference - `POST /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post) +**`deprecated`** Use DebugBee for postage batch management + #### Parameters | Name | Type | Description | @@ -137,7 +139,7 @@ For better understanding what each parameter means and what are the optimal valu #### Defined in -[bee-js/src/bee.ts:846](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L846) +[bee-js/src/bee.ts:848](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L848) ___ @@ -159,7 +161,7 @@ Create a new Tag which is meant for tracking progres of syncing data across netw #### Defined in -[bee-js/src/bee.ts:296](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L296) +[bee-js/src/bee.ts:297](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L297) ___ @@ -191,7 +193,7 @@ Delete Tag #### Defined in -[bee-js/src/bee.ts:350](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L350) +[bee-js/src/bee.ts:351](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L351) ___ @@ -217,7 +219,7 @@ Download data as a byte array #### Defined in -[bee-js/src/bee.ts:135](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L135) +[bee-js/src/bee.ts:136](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L136) ___ @@ -246,7 +248,7 @@ Download single file. #### Defined in -[bee-js/src/bee.ts:214](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L214) +[bee-js/src/bee.ts:215](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L215) ___ @@ -273,7 +275,7 @@ Download data as a Readable stream #### Defined in -[bee-js/src/bee.ts:149](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L149) +[bee-js/src/bee.ts:150](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L150) ___ @@ -300,7 +302,7 @@ Download single file as a readable stream #### Defined in -[bee-js/src/bee.ts:229](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L229) +[bee-js/src/bee.ts:230](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L230) ___ @@ -320,7 +322,7 @@ Get list of all locally pinned references #### Defined in -[bee-js/src/bee.ts:418](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L418) +[bee-js/src/bee.ts:419](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L419) ___ @@ -336,13 +338,15 @@ Return all postage batches that has the node available. **`see`** [Bee API reference - `GET /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get) +**`deprecated`** Use DebugBee for postage batch management + #### Returns `Promise`<[`PostageBatch`](../interfaces/postagebatch.md)[]\> #### Defined in -[bee-js/src/bee.ts:893](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L893) +[bee-js/src/bee.ts:897](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L897) ___ @@ -376,7 +380,7 @@ The listing is limited by options.limit. So you have to iterate using options.of #### Defined in -[bee-js/src/bee.ts:314](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L314) +[bee-js/src/bee.ts:315](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L315) ___ @@ -415,7 +419,7 @@ At least one of these has to be specified! #### Defined in -[bee-js/src/bee.ts:755](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L755) +[bee-js/src/bee.ts:756](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L756) ___ @@ -443,7 +447,7 @@ Get pinning status of chunk with given reference #### Defined in -[bee-js/src/bee.ts:432](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L432) +[bee-js/src/bee.ts:433](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L433) ___ @@ -459,6 +463,8 @@ Return details for specific postage batch. **`see`** [Bee API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{id}/get) +**`deprecated`** Use DebugBee for postage batch management + #### Parameters | Name | Type | Description | @@ -471,7 +477,7 @@ Return details for specific postage batch. #### Defined in -[bee-js/src/bee.ts:879](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L879) +[bee-js/src/bee.ts:882](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L882) ___ @@ -489,7 +495,7 @@ true if successful, false on error #### Defined in -[bee-js/src/bee.ts:911](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L911) +[bee-js/src/bee.ts:915](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L915) ___ @@ -515,7 +521,7 @@ Make a new feed reader for downloading feed updates. #### Defined in -[bee-js/src/bee.ts:668](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L668) +[bee-js/src/bee.ts:669](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L669) ___ @@ -540,7 +546,7 @@ hashes the input string to create a topic string of arbitrary length. #### Defined in -[bee-js/src/bee.ts:792](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L792) +[bee-js/src/bee.ts:793](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L793) ___ @@ -566,7 +572,7 @@ Make a new feed writer for updating feeds #### Defined in -[bee-js/src/bee.ts:690](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L690) +[bee-js/src/bee.ts:691](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L691) ___ @@ -590,7 +596,7 @@ Returns an object for reading single owner chunks #### Defined in -[bee-js/src/bee.ts:803](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L803) +[bee-js/src/bee.ts:804](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L804) ___ @@ -614,7 +620,7 @@ Returns an object for reading and writing single owner chunks #### Defined in -[bee-js/src/bee.ts:818](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L818) +[bee-js/src/bee.ts:819](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L819) ___ @@ -642,7 +648,7 @@ Pin local data with given reference #### Defined in -[bee-js/src/bee.ts:389](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L389) +[bee-js/src/bee.ts:390](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L390) ___ @@ -686,7 +692,7 @@ Message in byte array #### Defined in -[bee-js/src/bee.ts:596](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L596) +[bee-js/src/bee.ts:597](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L597) ___ @@ -728,7 +734,7 @@ This is because light nodes does not fully participate in the data exchange in S #### Defined in -[bee-js/src/bee.ts:485](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L485) +[bee-js/src/bee.ts:486](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L486) ___ @@ -762,7 +768,7 @@ Subscription to a given topic #### Defined in -[bee-js/src/bee.ts:525](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L525) +[bee-js/src/bee.ts:526](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L526) ___ @@ -792,7 +798,7 @@ Retrieve tag information from Bee node #### Defined in -[bee-js/src/bee.ts:332](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L332) +[bee-js/src/bee.ts:333](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L333) ___ @@ -819,7 +825,7 @@ Instructs the Bee node to reupload a locally pinned data into the network. #### Defined in -[bee-js/src/bee.ts:446](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L446) +[bee-js/src/bee.ts:447](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L447) ___ @@ -858,7 +864,7 @@ If none of those two is set error is thrown. #### Defined in -[bee-js/src/bee.ts:721](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L721) +[bee-js/src/bee.ts:722](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L722) ___ @@ -886,7 +892,7 @@ Unpin local data with given reference #### Defined in -[bee-js/src/bee.ts:405](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L405) +[bee-js/src/bee.ts:406](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L406) ___ @@ -922,7 +928,7 @@ you can use this method to update the total chunks count for the tag. #### Defined in -[bee-js/src/bee.ts:372](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L372) +[bee-js/src/bee.ts:373](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L373) ___ @@ -952,7 +958,7 @@ reference is a content hash of the data #### Defined in -[bee-js/src/bee.ts:115](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L115) +[bee-js/src/bee.ts:116](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L116) ___ @@ -988,7 +994,7 @@ reference is a content hash of the file #### Defined in -[bee-js/src/bee.ts:171](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L171) +[bee-js/src/bee.ts:172](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L172) ___ @@ -1020,7 +1026,7 @@ Uses the FileList API from the browser. #### Defined in -[bee-js/src/bee.ts:248](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L248) +[bee-js/src/bee.ts:249](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L249) ___ @@ -1052,4 +1058,4 @@ Available only in Node.js as it uses the `fs` module. #### Defined in -[bee-js/src/bee.ts:275](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee.ts#L275) +[bee-js/src/bee.ts:276](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee.ts#L276) diff --git a/docs/api/classes/beeargumenterror.md b/docs/api/classes/beeargumenterror.md index 62fe0320..092fed2c 100644 --- a/docs/api/classes/beeargumenterror.md +++ b/docs/api/classes/beeargumenterror.md @@ -31,7 +31,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/error.ts#L7) +[bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/error.ts#L7) ## Properties diff --git a/docs/api/classes/beedebug.md b/docs/api/classes/beedebug.md index ac83758b..93edf29b 100644 --- a/docs/api/classes/beedebug.md +++ b/docs/api/classes/beedebug.md @@ -24,7 +24,7 @@ The BeeDebug class provides a way of interacting with the Bee debug APIs based o #### Defined in -[bee-js/src/bee-debug.ts:40](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L40) +[bee-js/src/bee-debug.ts:54](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L54) ## Properties @@ -34,10 +34,33 @@ The BeeDebug class provides a way of interacting with the Bee debug APIs based o #### Defined in -[bee-js/src/bee-debug.ts:40](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L40) +[bee-js/src/bee-debug.ts:54](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L54) ## Methods +### cancelPendingTransaction + +▸ **cancelPendingTransaction**(`transactionHash`, `gasPrice?`): `Promise`<[`TransactionHash`](../types/transactionhash.md)\> + +Cancel currently pending transaction + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionHash` | `string` \| [`TransactionHash`](../types/transactionhash.md) | +| `gasPrice?` | [`NumberString`](../types/numberstring.md) | + +#### Returns + +`Promise`<[`TransactionHash`](../types/transactionhash.md)\> + +#### Defined in + +[bee-js/src/bee-debug.ts:428](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L428) + +___ + ### cashoutLastCheque ▸ **cashoutLastCheque**(`address`, `options?`): `Promise`<`string`\> @@ -57,7 +80,44 @@ Cashout the last cheque for the peer #### Defined in -[bee-js/src/bee-debug.ts:202](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L202) +[bee-js/src/bee-debug.ts:216](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L216) + +___ + +### createPostageBatch + +▸ **createPostageBatch**(`amount`, `depth`, `options?`): `Promise`<[`BatchId`](../types/batchid.md)\> + +Creates new postage batch from the funds that the node has available in its Ethereum account. + +For better understanding what each parameter means and what are the optimal values please see +[Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive). + +**WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY** + +**`throws`** BeeArgumentError when negative amount or depth is specified + +**`throws`** TypeError if non-integer value is passed to amount or depth + +**`see`** [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive) + +**`see`** [Bee Debug API reference - `POST /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | [`NumberString`](../types/numberstring.md) | Amount that represents the value per chunk, has to be greater or equal zero. | +| `depth` | `number` | Logarithm of the number of chunks that can be stamped with the batch. | +| `options?` | [`PostageBatchOptions`](../interfaces/postagebatchoptions.md) | Options for creation of postage batch | + +#### Returns + +`Promise`<[`BatchId`](../types/batchid.md)\> + +#### Defined in + +[bee-js/src/bee-debug.ts:333](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L333) ___ @@ -82,7 +142,7 @@ string Hash of the transaction #### Defined in -[bee-js/src/bee-debug.ts:223](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L223) +[bee-js/src/bee-debug.ts:237](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L237) ___ @@ -98,7 +158,43 @@ Get the balances with all known peers including prepaid services #### Defined in -[bee-js/src/bee-debug.ts:111](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L111) +[bee-js/src/bee-debug.ts:125](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L125) + +___ + +### getAllPendingTransactions + +▸ **getAllPendingTransactions**(): `Promise`<[`TransactionInfo`](../interfaces/transactioninfo.md)[]\> + +Return lists of all current pending transactions that the Bee made + +#### Returns + +`Promise`<[`TransactionInfo`](../interfaces/transactioninfo.md)[]\> + +#### Defined in + +[bee-js/src/bee-debug.ts:397](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L397) + +___ + +### getAllPostageBatch + +▸ **getAllPostageBatch**(): `Promise`<[`DebugPostageBatch`](../interfaces/debugpostagebatch.md)[]\> + +Return all postage batches that has the node available. + +**`see`** [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive) + +**`see`** [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps/get) + +#### Returns + +`Promise`<[`DebugPostageBatch`](../interfaces/debugpostagebatch.md)[]\> + +#### Defined in + +[bee-js/src/bee-debug.ts:390](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L390) ___ @@ -114,7 +210,7 @@ Get settlements with all known peers and total amount sent or received #### Defined in -[bee-js/src/bee-debug.ts:268](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L268) +[bee-js/src/bee-debug.ts:282](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L282) ___ @@ -128,7 +224,7 @@ ___ #### Defined in -[bee-js/src/bee-debug.ts:55](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L55) +[bee-js/src/bee-debug.ts:69](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L69) ___ @@ -144,7 +240,7 @@ Get chain state #### Defined in -[bee-js/src/bee-debug.ts:298](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L298) +[bee-js/src/bee-debug.ts:312](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L312) ___ @@ -163,7 +259,7 @@ https://github.com/ethersphere/bee/issues/1443 #### Defined in -[bee-js/src/bee-debug.ts:154](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L154) +[bee-js/src/bee-debug.ts:168](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L168) ___ @@ -179,7 +275,7 @@ Get the balance of the chequebook #### Defined in -[bee-js/src/bee-debug.ts:161](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L161) +[bee-js/src/bee-debug.ts:175](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L175) ___ @@ -195,7 +291,7 @@ Get health of node #### Defined in -[bee-js/src/bee-debug.ts:275](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L275) +[bee-js/src/bee-debug.ts:289](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L289) ___ @@ -217,7 +313,7 @@ Get last cashout action for the peer #### Defined in -[bee-js/src/bee-debug.ts:188](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L188) +[bee-js/src/bee-debug.ts:202](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L202) ___ @@ -233,7 +329,7 @@ Get last cheques for all peers #### Defined in -[bee-js/src/bee-debug.ts:168](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L168) +[bee-js/src/bee-debug.ts:182](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L182) ___ @@ -255,7 +351,7 @@ Get last cheques for the peer #### Defined in -[bee-js/src/bee-debug.ts:177](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L177) +[bee-js/src/bee-debug.ts:191](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L191) ___ @@ -269,7 +365,7 @@ ___ #### Defined in -[bee-js/src/bee-debug.ts:51](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L51) +[bee-js/src/bee-debug.ts:65](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L65) ___ @@ -285,7 +381,7 @@ Get the past due consumption balances with all known peers #### Defined in -[bee-js/src/bee-debug.ts:129](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L129) +[bee-js/src/bee-debug.ts:143](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L143) ___ @@ -307,7 +403,7 @@ Get the past due consumption balance with a specific peer #### Defined in -[bee-js/src/bee-debug.ts:138](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L138) +[bee-js/src/bee-debug.ts:152](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L152) ___ @@ -329,7 +425,7 @@ Get the balances with a specific peer including prepaid services #### Defined in -[bee-js/src/bee-debug.ts:120](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L120) +[bee-js/src/bee-debug.ts:134](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L134) ___ @@ -345,7 +441,81 @@ Get list of peers for this node #### Defined in -[bee-js/src/bee-debug.ts:84](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L84) +[bee-js/src/bee-debug.ts:98](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L98) + +___ + +### getPendingTransaction + +▸ **getPendingTransaction**(`transactionHash`): `Promise`<[`TransactionInfo`](../interfaces/transactioninfo.md)\> + +Return transaction information for specific transaction + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionHash` | `string` \| [`TransactionHash`](../types/transactionhash.md) | + +#### Returns + +`Promise`<[`TransactionInfo`](../interfaces/transactioninfo.md)\> + +#### Defined in + +[bee-js/src/bee-debug.ts:405](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L405) + +___ + +### getPostageBatch + +▸ **getPostageBatch**(`postageBatchId`): `Promise`<[`DebugPostageBatch`](../interfaces/debugpostagebatch.md)\> + +Return details for specific postage batch. + +**`see`** [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive) + +**`see`** [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}/get) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `postageBatchId` | `string` \| [`BatchId`](../types/batchid.md) | Batch ID | + +#### Returns + +`Promise`<[`DebugPostageBatch`](../interfaces/debugpostagebatch.md)\> + +#### Defined in + +[bee-js/src/bee-debug.ts:364](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L364) + +___ + +### getPostageBatchBuckets + +▸ **getPostageBatchBuckets**(`postageBatchId`): `Promise`<[`PostageBatchBuckets`](../interfaces/postagebatchbuckets.md)\> + +Return detailed information related to buckets for specific postage batch. + +**`see`** [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive) + +**`see`** [Bee Debug API reference - `GET /stamps/${id}/buckets`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}~1buckets/get) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `postageBatchId` | `string` \| [`BatchId`](../types/batchid.md) | Batch ID | + +#### Returns + +`Promise`<[`PostageBatchBuckets`](../interfaces/postagebatchbuckets.md)\> + +#### Defined in + +[bee-js/src/bee-debug.ts:378](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L378) ___ @@ -361,7 +531,7 @@ Get reserve state #### Defined in -[bee-js/src/bee-debug.ts:291](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L291) +[bee-js/src/bee-debug.ts:305](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L305) ___ @@ -383,7 +553,7 @@ Get amount of sent and received from settlements with a peer #### Defined in -[bee-js/src/bee-debug.ts:259](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L259) +[bee-js/src/bee-debug.ts:273](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L273) ___ @@ -397,7 +567,7 @@ ___ #### Defined in -[bee-js/src/bee-debug.ts:94](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L94) +[bee-js/src/bee-debug.ts:108](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L108) ___ @@ -415,7 +585,7 @@ true if the Bee node version is supported #### Defined in -[bee-js/src/bee-debug.ts:284](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L284) +[bee-js/src/bee-debug.ts:298](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L298) ___ @@ -435,7 +605,30 @@ ___ #### Defined in -[bee-js/src/bee-debug.ts:98](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L98) +[bee-js/src/bee-debug.ts:112](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L112) + +___ + +### rebroadcastPendingTransaction + +▸ **rebroadcastPendingTransaction**(`transactionHash`): `Promise`<[`TransactionHash`](../types/transactionhash.md)\> + +Rebroadcast already created transaction. +This is mainly needed when your transaction fall off mempool from other reason is not incorporated into block. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionHash` | `string` \| [`TransactionHash`](../types/transactionhash.md) | + +#### Returns + +`Promise`<[`TransactionHash`](../types/transactionhash.md)\> + +#### Defined in + +[bee-js/src/bee-debug.ts:417](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L417) ___ @@ -455,7 +648,7 @@ ___ #### Defined in -[bee-js/src/bee-debug.ts:88](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L88) +[bee-js/src/bee-debug.ts:102](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L102) ___ @@ -483,7 +676,7 @@ Retrieve tag extended information from Bee node #### Defined in -[bee-js/src/bee-debug.ts:69](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L69) +[bee-js/src/bee-debug.ts:83](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L83) ___ @@ -508,4 +701,4 @@ string Hash of the transaction #### Defined in -[bee-js/src/bee-debug.ts:240](https://github.com/ethersphere/bee-js/blob/6f227e1/src/bee-debug.ts#L240) +[bee-js/src/bee-debug.ts:254](https://github.com/ethersphere/bee-js/blob/74056cb/src/bee-debug.ts#L254) diff --git a/docs/api/classes/beeerror.md b/docs/api/classes/beeerror.md index 67243a4a..362e1bcf 100644 --- a/docs/api/classes/beeerror.md +++ b/docs/api/classes/beeerror.md @@ -36,7 +36,7 @@ Error.constructor #### Defined in -[bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/error.ts#L1) +[bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/error.ts#L1) ## Properties diff --git a/docs/api/classes/beerequesterror.md b/docs/api/classes/beerequesterror.md index 01a40f05..ae935101 100644 --- a/docs/api/classes/beerequesterror.md +++ b/docs/api/classes/beerequesterror.md @@ -30,7 +30,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/error.ts#L13) +[bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/error.ts#L13) ## Properties diff --git a/docs/api/classes/beeresponseerror.md b/docs/api/classes/beeresponseerror.md index e697334d..2a579648 100644 --- a/docs/api/classes/beeresponseerror.md +++ b/docs/api/classes/beeresponseerror.md @@ -31,7 +31,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/error.ts#L19) +[bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/error.ts#L19) ## Properties diff --git a/docs/api/functions/utils.bytes.assertbytes.md b/docs/api/functions/utils.bytes.assertbytes.md index 685a8600..cc331d2d 100644 --- a/docs/api/functions/utils.bytes.assertbytes.md +++ b/docs/api/functions/utils.bytes.assertbytes.md @@ -30,4 +30,4 @@ asserts b is Bytes #### Defined in -[bee-js/src/utils/bytes.ts:44](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L44) +[bee-js/src/utils/bytes.ts:44](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L44) diff --git a/docs/api/functions/utils.bytes.assertflexbytes.md b/docs/api/functions/utils.bytes.assertflexbytes.md index 83a07726..f675ddc0 100644 --- a/docs/api/functions/utils.bytes.assertflexbytes.md +++ b/docs/api/functions/utils.bytes.assertflexbytes.md @@ -32,4 +32,4 @@ asserts b is FlexBytes #### Defined in -[bee-js/src/utils/bytes.ts:72](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L72) +[bee-js/src/utils/bytes.ts:72](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L72) diff --git a/docs/api/functions/utils.bytes.bytesatoffset.md b/docs/api/functions/utils.bytes.bytesatoffset.md index 2f8cf67c..e4709f40 100644 --- a/docs/api/functions/utils.bytes.bytesatoffset.md +++ b/docs/api/functions/utils.bytes.bytesatoffset.md @@ -31,4 +31,4 @@ Return `length` bytes starting from `offset` #### Defined in -[bee-js/src/utils/bytes.ts:91](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L91) +[bee-js/src/utils/bytes.ts:91](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L91) diff --git a/docs/api/functions/utils.bytes.bytesequal.md b/docs/api/functions/utils.bytes.bytesequal.md index 6459c351..b27c4d74 100644 --- a/docs/api/functions/utils.bytes.bytesequal.md +++ b/docs/api/functions/utils.bytes.bytesequal.md @@ -24,4 +24,4 @@ Returns true if two byte arrays are equal #### Defined in -[bee-js/src/utils/bytes.ts:125](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L125) +[bee-js/src/utils/bytes.ts:125](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L125) diff --git a/docs/api/functions/utils.bytes.flexbytesatoffset.md b/docs/api/functions/utils.bytes.flexbytesatoffset.md index 7851d09e..aec3570b 100644 --- a/docs/api/functions/utils.bytes.flexbytesatoffset.md +++ b/docs/api/functions/utils.bytes.flexbytesatoffset.md @@ -33,4 +33,4 @@ Return flex bytes starting from `offset` #### Defined in -[bee-js/src/utils/bytes.ts:108](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L108) +[bee-js/src/utils/bytes.ts:108](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L108) diff --git a/docs/api/functions/utils.bytes.isbytes.md b/docs/api/functions/utils.bytes.isbytes.md index a5270452..b77fd8f6 100644 --- a/docs/api/functions/utils.bytes.isbytes.md +++ b/docs/api/functions/utils.bytes.isbytes.md @@ -30,4 +30,4 @@ b is Bytes #### Defined in -[bee-js/src/utils/bytes.ts:34](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L34) +[bee-js/src/utils/bytes.ts:34](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L34) diff --git a/docs/api/functions/utils.bytes.isflexbytes.md b/docs/api/functions/utils.bytes.isflexbytes.md index d330507a..6bd66d8f 100644 --- a/docs/api/functions/utils.bytes.isflexbytes.md +++ b/docs/api/functions/utils.bytes.isflexbytes.md @@ -32,4 +32,4 @@ b is FlexBytes #### Defined in -[bee-js/src/utils/bytes.ts:57](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L57) +[bee-js/src/utils/bytes.ts:57](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L57) diff --git a/docs/api/functions/utils.bytes.makebytes.md b/docs/api/functions/utils.bytes.makebytes.md index 3a899905..14b68e53 100644 --- a/docs/api/functions/utils.bytes.makebytes.md +++ b/docs/api/functions/utils.bytes.makebytes.md @@ -29,4 +29,4 @@ Returns a new byte array filled with zeroes with the specified length #### Defined in -[bee-js/src/utils/bytes.ts:134](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L134) +[bee-js/src/utils/bytes.ts:134](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L134) diff --git a/docs/api/functions/utils.bytes.wrapbyteswithhelpers.md b/docs/api/functions/utils.bytes.wrapbyteswithhelpers.md index 3aa98e3c..408dc090 100644 --- a/docs/api/functions/utils.bytes.wrapbyteswithhelpers.md +++ b/docs/api/functions/utils.bytes.wrapbyteswithhelpers.md @@ -21,4 +21,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/bytes.ts:138](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L138) +[bee-js/src/utils/bytes.ts:138](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L138) diff --git a/docs/api/functions/utils.collections.assertcollection.md b/docs/api/functions/utils.collections.assertcollection.md index b9ae60de..39ece112 100644 --- a/docs/api/functions/utils.collections.assertcollection.md +++ b/docs/api/functions/utils.collections.assertcollection.md @@ -21,4 +21,4 @@ asserts data is Collection #### Defined in -[bee-js/src/utils/collection.ts:16](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/collection.ts#L16) +[bee-js/src/utils/collection.ts:16](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/collection.ts#L16) diff --git a/docs/api/functions/utils.collections.getcollectionsize.md b/docs/api/functions/utils.collections.getcollectionsize.md index 921bc449..235ccc84 100644 --- a/docs/api/functions/utils.collections.getcollectionsize.md +++ b/docs/api/functions/utils.collections.getcollectionsize.md @@ -25,4 +25,4 @@ size in bytes #### Defined in -[bee-js/src/utils/collection.ts:109](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/collection.ts#L109) +[bee-js/src/utils/collection.ts:109](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/collection.ts#L109) diff --git a/docs/api/functions/utils.collections.getfoldersize.md b/docs/api/functions/utils.collections.getfoldersize.md index e97787e0..ed52a21e 100644 --- a/docs/api/functions/utils.collections.getfoldersize.md +++ b/docs/api/functions/utils.collections.getfoldersize.md @@ -25,4 +25,4 @@ size in bytes #### Defined in -[bee-js/src/utils/collection.ts:129](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/collection.ts#L129) +[bee-js/src/utils/collection.ts:129](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/collection.ts#L129) diff --git a/docs/api/functions/utils.collections.iscollection.md b/docs/api/functions/utils.collections.iscollection.md index cb7888a1..08377d08 100644 --- a/docs/api/functions/utils.collections.iscollection.md +++ b/docs/api/functions/utils.collections.iscollection.md @@ -21,4 +21,4 @@ data is Collection #### Defined in -[bee-js/src/utils/collection.ts:8](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/collection.ts#L8) +[bee-js/src/utils/collection.ts:8](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/collection.ts#L8) diff --git a/docs/api/functions/utils.collections.makecollectionfromfilelist.md b/docs/api/functions/utils.collections.makecollectionfromfilelist.md index fd0010de..35bd1230 100644 --- a/docs/api/functions/utils.collections.makecollectionfromfilelist.md +++ b/docs/api/functions/utils.collections.makecollectionfromfilelist.md @@ -21,4 +21,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/collection.ts:86](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/collection.ts#L86) +[bee-js/src/utils/collection.ts:86](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/collection.ts#L86) diff --git a/docs/api/functions/utils.collections.makecollectionfromfs.md b/docs/api/functions/utils.collections.makecollectionfromfs.md index 6589de61..7dde05ef 100644 --- a/docs/api/functions/utils.collections.makecollectionfromfs.md +++ b/docs/api/functions/utils.collections.makecollectionfromfs.md @@ -24,4 +24,4 @@ The function loads all the data into memory! #### Defined in -[bee-js/src/utils/collection.ts:28](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/collection.ts#L28) +[bee-js/src/utils/collection.ts:28](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/collection.ts#L28) diff --git a/docs/api/functions/utils.data.preparedata.md b/docs/api/functions/utils.data.preparedata.md index f5c039f9..50dfe0a9 100644 --- a/docs/api/functions/utils.data.preparedata.md +++ b/docs/api/functions/utils.data.preparedata.md @@ -23,4 +23,4 @@ Validates input and converts to Uint8Array or Readable #### Defined in -[bee-js/src/utils/data.ts:9](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/data.ts#L9) +[bee-js/src/utils/data.ts:9](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/data.ts#L9) diff --git a/docs/api/functions/utils.data.preparewebsocketdata.md b/docs/api/functions/utils.data.preparewebsocketdata.md index 84f84a09..e7d4936d 100644 --- a/docs/api/functions/utils.data.preparewebsocketdata.md +++ b/docs/api/functions/utils.data.preparewebsocketdata.md @@ -21,4 +21,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/data.ts:23](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/data.ts#L23) +[bee-js/src/utils/data.ts:23](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/data.ts#L23) diff --git a/docs/api/functions/utils.eth.ethtoswarmaddress.md b/docs/api/functions/utils.eth.ethtoswarmaddress.md index 13e81202..100bc7f3 100644 --- a/docs/api/functions/utils.eth.ethtoswarmaddress.md +++ b/docs/api/functions/utils.eth.ethtoswarmaddress.md @@ -26,4 +26,4 @@ Swarm overlay address #### Defined in -[bee-js/src/utils/eth.ts:162](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L162) +[bee-js/src/utils/eth.ts:162](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L162) diff --git a/docs/api/functions/utils.eth.fromlittleendian.md b/docs/api/functions/utils.eth.fromlittleendian.md index 8b2c92c1..88272c04 100644 --- a/docs/api/functions/utils.eth.fromlittleendian.md +++ b/docs/api/functions/utils.eth.fromlittleendian.md @@ -27,4 +27,4 @@ big-endian encoded hexstring #### Defined in -[bee-js/src/utils/eth.ts:139](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L139) +[bee-js/src/utils/eth.ts:139](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L139) diff --git a/docs/api/functions/utils.eth.ishexethaddress.md b/docs/api/functions/utils.eth.ishexethaddress.md index fbfa5169..1c57e94c 100644 --- a/docs/api/functions/utils.eth.ishexethaddress.md +++ b/docs/api/functions/utils.eth.ishexethaddress.md @@ -28,4 +28,4 @@ True if is valid eth address #### Defined in -[bee-js/src/utils/eth.ts:93](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L93) +[bee-js/src/utils/eth.ts:93](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L93) diff --git a/docs/api/functions/utils.eth.makeethaddress.md b/docs/api/functions/utils.eth.makeethaddress.md index aad0d4c7..be1c4da5 100644 --- a/docs/api/functions/utils.eth.makeethaddress.md +++ b/docs/api/functions/utils.eth.makeethaddress.md @@ -21,4 +21,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/eth.ts:12](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L12) +[bee-js/src/utils/eth.ts:12](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L12) diff --git a/docs/api/functions/utils.eth.makeethereumwalletsigner.md b/docs/api/functions/utils.eth.makeethereumwalletsigner.md index 306217ac..0f9eb3b6 100644 --- a/docs/api/functions/utils.eth.makeethereumwalletsigner.md +++ b/docs/api/functions/utils.eth.makeethereumwalletsigner.md @@ -25,4 +25,4 @@ uses `personal_sign` method to sign requested data. #### Defined in -[bee-js/src/utils/eth.ts:192](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L192) +[bee-js/src/utils/eth.ts:192](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L192) diff --git a/docs/api/functions/utils.eth.makehexethaddress.md b/docs/api/functions/utils.eth.makehexethaddress.md index 3e32ed1e..776e4713 100644 --- a/docs/api/functions/utils.eth.makehexethaddress.md +++ b/docs/api/functions/utils.eth.makehexethaddress.md @@ -21,4 +21,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/eth.ts:27](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L27) +[bee-js/src/utils/eth.ts:27](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L27) diff --git a/docs/api/functions/utils.eth.tolittleendian.md b/docs/api/functions/utils.eth.tolittleendian.md index 1ee3650c..f834d739 100644 --- a/docs/api/functions/utils.eth.tolittleendian.md +++ b/docs/api/functions/utils.eth.tolittleendian.md @@ -27,4 +27,4 @@ little-endian encoded hexstring #### Defined in -[bee-js/src/utils/eth.ts:106](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L106) +[bee-js/src/utils/eth.ts:106](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L106) diff --git a/docs/api/functions/utils.file.filearraybuffer.md b/docs/api/functions/utils.file.filearraybuffer.md index 932e5a30..d42fb887 100644 --- a/docs/api/functions/utils.file.filearraybuffer.md +++ b/docs/api/functions/utils.file.filearraybuffer.md @@ -24,4 +24,4 @@ missing from `File` objects. #### Defined in -[bee-js/src/utils/file.ts:29](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/file.ts#L29) +[bee-js/src/utils/file.ts:29](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/file.ts#L29) diff --git a/docs/api/functions/utils.file.isfile.md b/docs/api/functions/utils.file.isfile.md index dc40d255..aea6bcec 100644 --- a/docs/api/functions/utils.file.isfile.md +++ b/docs/api/functions/utils.file.isfile.md @@ -25,4 +25,4 @@ file is File #### Defined in -[bee-js/src/utils/file.ts:7](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/file.ts#L7) +[bee-js/src/utils/file.ts:7](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/file.ts#L7) diff --git a/docs/api/functions/utils.hex.asserthexstring.md b/docs/api/functions/utils.hex.asserthexstring.md index b8a65465..0964167d 100644 --- a/docs/api/functions/utils.hex.asserthexstring.md +++ b/docs/api/functions/utils.hex.asserthexstring.md @@ -35,4 +35,4 @@ HexString or throws error #### Defined in -[bee-js/src/utils/hex.ts:158](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L158) +[bee-js/src/utils/hex.ts:158](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L158) diff --git a/docs/api/functions/utils.hex.assertprefixedhexstring.md b/docs/api/functions/utils.hex.assertprefixedhexstring.md index c0a6bd86..df590d0a 100644 --- a/docs/api/functions/utils.hex.assertprefixedhexstring.md +++ b/docs/api/functions/utils.hex.assertprefixedhexstring.md @@ -26,4 +26,4 @@ HexString or throws error #### Defined in -[bee-js/src/utils/hex.ts:182](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L182) +[bee-js/src/utils/hex.ts:182](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L182) diff --git a/docs/api/functions/utils.hex.bytestohex.md b/docs/api/functions/utils.hex.bytestohex.md index 960b7239..a7cc1e2c 100644 --- a/docs/api/functions/utils.hex.bytestohex.md +++ b/docs/api/functions/utils.hex.bytestohex.md @@ -30,4 +30,4 @@ Converts array of number or Uint8Array to HexString without prefix. #### Defined in -[bee-js/src/utils/hex.ts:89](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L89) +[bee-js/src/utils/hex.ts:89](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L89) diff --git a/docs/api/functions/utils.hex.hextobytes.md b/docs/api/functions/utils.hex.hextobytes.md index 8cedae95..0d99531c 100644 --- a/docs/api/functions/utils.hex.hextobytes.md +++ b/docs/api/functions/utils.hex.hextobytes.md @@ -30,4 +30,4 @@ Converts a hex string to Uint8Array #### Defined in -[bee-js/src/utils/hex.ts:69](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L69) +[bee-js/src/utils/hex.ts:69](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L69) diff --git a/docs/api/functions/utils.hex.inttohex.md b/docs/api/functions/utils.hex.inttohex.md index f15c2d94..5826b4ab 100644 --- a/docs/api/functions/utils.hex.inttohex.md +++ b/docs/api/functions/utils.hex.inttohex.md @@ -32,4 +32,4 @@ Optionally provides '0x' prefix or padding #### Defined in -[bee-js/src/utils/hex.ts:109](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L109) +[bee-js/src/utils/hex.ts:109](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L109) diff --git a/docs/api/functions/utils.hex.ishexstring.md b/docs/api/functions/utils.hex.ishexstring.md index d95ab018..4aba098c 100644 --- a/docs/api/functions/utils.hex.ishexstring.md +++ b/docs/api/functions/utils.hex.ishexstring.md @@ -33,4 +33,4 @@ s is HexString #### Defined in -[bee-js/src/utils/hex.ts:134](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L134) +[bee-js/src/utils/hex.ts:134](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L134) diff --git a/docs/api/functions/utils.hex.isprefixedhexstring.md b/docs/api/functions/utils.hex.isprefixedhexstring.md index dd541ca4..5432c778 100644 --- a/docs/api/functions/utils.hex.isprefixedhexstring.md +++ b/docs/api/functions/utils.hex.isprefixedhexstring.md @@ -24,4 +24,4 @@ s is PrefixedHexString #### Defined in -[bee-js/src/utils/hex.ts:144](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L144) +[bee-js/src/utils/hex.ts:144](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L144) diff --git a/docs/api/functions/utils.hex.makehexstring.md b/docs/api/functions/utils.hex.makehexstring.md index c37e2645..137a949a 100644 --- a/docs/api/functions/utils.hex.makehexstring.md +++ b/docs/api/functions/utils.hex.makehexstring.md @@ -32,4 +32,4 @@ TODO: Make Length mandatory: https://github.com/ethersphere/bee-js/issues/208 #### Defined in -[bee-js/src/utils/hex.ts:33](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L33) +[bee-js/src/utils/hex.ts:33](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L33) diff --git a/docs/api/functions/utils.hooks.clearonrequest.md b/docs/api/functions/utils.hooks.clearonrequest.md index e6ad6f44..3edff863 100644 --- a/docs/api/functions/utils.hooks.clearonrequest.md +++ b/docs/api/functions/utils.hooks.clearonrequest.md @@ -23,4 +23,4 @@ Function that stops forwarding new requests to associated listener callback #### Defined in -[bee-js/src/utils/hooks.ts:64](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hooks.ts#L64) +[bee-js/src/utils/hooks.ts:67](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hooks.ts#L67) diff --git a/docs/api/functions/utils.hooks.clearonresponse.md b/docs/api/functions/utils.hooks.clearonresponse.md index f3327de0..c7b7a4d0 100644 --- a/docs/api/functions/utils.hooks.clearonresponse.md +++ b/docs/api/functions/utils.hooks.clearonresponse.md @@ -23,4 +23,4 @@ Function that stops forwarding new responses to associated listener callback #### Defined in -[bee-js/src/utils/hooks.ts:84](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hooks.ts#L84) +[bee-js/src/utils/hooks.ts:87](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hooks.ts#L87) diff --git a/docs/api/functions/utils.hooks.onrequest.md b/docs/api/functions/utils.hooks.onrequest.md index ee3f99ed..7eb6bb2b 100644 --- a/docs/api/functions/utils.hooks.onrequest.md +++ b/docs/api/functions/utils.hooks.onrequest.md @@ -27,4 +27,4 @@ ID of the listener that can be used to stop the callback to receive new requests #### Defined in -[bee-js/src/utils/hooks.ts:56](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hooks.ts#L56) +[bee-js/src/utils/hooks.ts:59](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hooks.ts#L59) diff --git a/docs/api/functions/utils.hooks.onresponse.md b/docs/api/functions/utils.hooks.onresponse.md index 2a4e7f66..78e68565 100644 --- a/docs/api/functions/utils.hooks.onresponse.md +++ b/docs/api/functions/utils.hooks.onresponse.md @@ -27,4 +27,4 @@ ID of the listener that can be used to stop the callback to receive new response #### Defined in -[bee-js/src/utils/hooks.ts:76](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hooks.ts#L76) +[bee-js/src/utils/hooks.ts:79](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hooks.ts#L79) diff --git a/docs/api/functions/utils.keccak256hash.md b/docs/api/functions/utils.keccak256hash.md index 91e4205b..8b312a84 100644 --- a/docs/api/functions/utils.keccak256hash.md +++ b/docs/api/functions/utils.keccak256hash.md @@ -24,4 +24,4 @@ correct types. #### Defined in -[bee-js/src/utils/hash.ts:10](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hash.ts#L10) +[bee-js/src/utils/hash.ts:10](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hash.ts#L10) diff --git a/docs/api/functions/utils.setdefaultheaders.md b/docs/api/functions/utils.setdefaultheaders.md index 74d61cbf..6699c4bb 100644 --- a/docs/api/functions/utils.setdefaultheaders.md +++ b/docs/api/functions/utils.setdefaultheaders.md @@ -23,4 +23,4 @@ Utility function that sets passed headers to ALL axios calls without distinction #### Defined in -[bee-js/src/utils/safe-axios.ts:13](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/safe-axios.ts#L13) +[bee-js/src/utils/safe-axios.ts:13](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/safe-axios.ts#L13) diff --git a/docs/api/functions/utils.tar.maketar.md b/docs/api/functions/utils.tar.maketar.md index 5d9cce71..45d04954 100644 --- a/docs/api/functions/utils.tar.maketar.md +++ b/docs/api/functions/utils.tar.maketar.md @@ -21,4 +21,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/tar.ts:22](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/tar.ts#L22) +[bee-js/src/utils/tar.ts:22](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/tar.ts#L22) diff --git a/docs/api/index.md b/docs/api/index.md index f6689684..c335756e 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -25,6 +25,7 @@ custom_edit_url: null - [AllSettlements](interfaces/allsettlements.md) - [AllTagsOptions](interfaces/alltagsoptions.md) - [BalanceResponse](interfaces/balanceresponse.md) +- [BatchBucket](interfaces/batchbucket.md) - [BeeGenericResponse](interfaces/beegenericresponse.md) - [BeeOptions](interfaces/beeoptions.md) - [BeeRequest](interfaces/beerequest.md) @@ -39,6 +40,7 @@ custom_edit_url: null - [CollectionEntry](interfaces/collectionentry.md) - [CollectionUploadOptions](interfaces/collectionuploadoptions.md) - [Data](interfaces/data.md) +- [DebugPostageBatch](interfaces/debugpostagebatch.md) - [Dictionary](interfaces/dictionary.md) - [ExtendedTag](interfaces/extendedtag.md) - [FeedReader](interfaces/feedreader.md) @@ -57,6 +59,7 @@ custom_edit_url: null - [Pin](interfaces/pin.md) - [PingResponse](interfaces/pingresponse.md) - [PostageBatch](interfaces/postagebatch.md) +- [PostageBatchBuckets](interfaces/postagebatchbuckets.md) - [PostageBatchOptions](interfaces/postagebatchoptions.md) - [PssMessageHandler](interfaces/pssmessagehandler.md) - [PssSubscription](interfaces/psssubscription.md) @@ -68,6 +71,7 @@ custom_edit_url: null - [Settlements](interfaces/settlements.md) - [Tag](interfaces/tag.md) - [Topology](interfaces/topology.md) +- [TransactionInfo](interfaces/transactioninfo.md) - [TransactionResponse](interfaces/transactionresponse.md) - [UploadHeaders](interfaces/uploadheaders.md) - [UploadOptions](interfaces/uploadoptions.md) @@ -90,6 +94,7 @@ custom_edit_url: null - [Signature](types/signature.md) - [Signer](types/signer.md) - [Topic](types/topic.md) +- [TransactionHash](types/transactionhash.md) ## Variables diff --git a/docs/api/interfaces/allsettlements.md b/docs/api/interfaces/allsettlements.md index 3583968c..e8cbf635 100644 --- a/docs/api/interfaces/allsettlements.md +++ b/docs/api/interfaces/allsettlements.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:65](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L65) +[bee-js/src/types/debug.ts:65](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L65) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:63](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L63) +[bee-js/src/types/debug.ts:63](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L63) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:64](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L64) +[bee-js/src/types/debug.ts:64](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L64) diff --git a/docs/api/interfaces/alltagsoptions.md b/docs/api/interfaces/alltagsoptions.md index 46407ed7..b2ddd905 100644 --- a/docs/api/interfaces/alltagsoptions.md +++ b/docs/api/interfaces/alltagsoptions.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:179](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L179) +[bee-js/src/types/index.ts:179](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L179) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:180](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L180) +[bee-js/src/types/index.ts:180](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L180) diff --git a/docs/api/interfaces/balanceresponse.md b/docs/api/interfaces/balanceresponse.md index 1fd1b630..ba6aaa3e 100644 --- a/docs/api/interfaces/balanceresponse.md +++ b/docs/api/interfaces/balanceresponse.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:141](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L141) +[bee-js/src/types/debug.ts:141](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L141) diff --git a/docs/api/interfaces/batchbucket.md b/docs/api/interfaces/batchbucket.md new file mode 100644 index 00000000..014bc27d --- /dev/null +++ b/docs/api/interfaces/batchbucket.md @@ -0,0 +1,27 @@ +--- +id: "batchbucket" +title: "Interface: BatchBucket" +sidebar_label: "BatchBucket" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### bucketID + +• **bucketID**: `number` + +#### Defined in + +[bee-js/src/types/index.ts:392](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L392) + +___ + +### collisions + +• **collisions**: `number` + +#### Defined in + +[bee-js/src/types/index.ts:393](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L393) diff --git a/docs/api/interfaces/beegenericresponse.md b/docs/api/interfaces/beegenericresponse.md index 24b08ca1..2a69ea93 100644 --- a/docs/api/interfaces/beegenericresponse.md +++ b/docs/api/interfaces/beegenericresponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:250](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L250) +[bee-js/src/types/index.ts:250](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L250) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:249](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L249) +[bee-js/src/types/index.ts:249](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L249) diff --git a/docs/api/interfaces/beeoptions.md b/docs/api/interfaces/beeoptions.md index 8b4e8f99..49720540 100644 --- a/docs/api/interfaces/beeoptions.md +++ b/docs/api/interfaces/beeoptions.md @@ -16,4 +16,4 @@ Signer object or private key of the Signer in form of either hex string or Uint8 #### Defined in -[bee-js/src/types/index.ts:65](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L65) +[bee-js/src/types/index.ts:65](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L65) diff --git a/docs/api/interfaces/beerequest.md b/docs/api/interfaces/beerequest.md index b47d9c73..33eb9e8e 100644 --- a/docs/api/interfaces/beerequest.md +++ b/docs/api/interfaces/beerequest.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:264](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L264) +[bee-js/src/types/index.ts:264](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L264) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:262](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L262) +[bee-js/src/types/index.ts:262](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L262) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:261](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L261) +[bee-js/src/types/index.ts:261](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L261) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:263](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L263) +[bee-js/src/types/index.ts:263](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L263) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:260](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L260) +[bee-js/src/types/index.ts:260](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L260) diff --git a/docs/api/interfaces/beeresponse.md b/docs/api/interfaces/beeresponse.md index 47e20a8b..c80127ee 100644 --- a/docs/api/interfaces/beeresponse.md +++ b/docs/api/interfaces/beeresponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:269](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L269) +[bee-js/src/types/index.ts:269](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L269) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:268](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L268) +[bee-js/src/types/index.ts:268](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L268) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:272](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L272) +[bee-js/src/types/index.ts:272](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L272) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:270](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L270) +[bee-js/src/types/index.ts:270](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L270) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:271](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L271) +[bee-js/src/types/index.ts:271](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L271) diff --git a/docs/api/interfaces/bin.md b/docs/api/interfaces/bin.md index 57c7e4f1..d3b4e341 100644 --- a/docs/api/interfaces/bin.md +++ b/docs/api/interfaces/bin.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:156](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L156) +[bee-js/src/types/debug.ts:156](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L156) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:158](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L158) +[bee-js/src/types/debug.ts:158](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L158) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:157](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L157) +[bee-js/src/types/debug.ts:157](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L157) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:155](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L155) +[bee-js/src/types/debug.ts:155](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L155) diff --git a/docs/api/interfaces/cashoutoptions.md b/docs/api/interfaces/cashoutoptions.md index 35e1163e..f374b0e9 100644 --- a/docs/api/interfaces/cashoutoptions.md +++ b/docs/api/interfaces/cashoutoptions.md @@ -16,7 +16,7 @@ Gas limit for the cashout transaction in WEI #### Defined in -[bee-js/src/types/debug.ts:98](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L98) +[bee-js/src/types/debug.ts:98](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L98) ___ @@ -28,4 +28,4 @@ Gas price for the cashout transaction in WEI #### Defined in -[bee-js/src/types/debug.ts:93](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L93) +[bee-js/src/types/debug.ts:93](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L93) diff --git a/docs/api/interfaces/cashoutresult.md b/docs/api/interfaces/cashoutresult.md index 6a30c9c4..b42fac83 100644 --- a/docs/api/interfaces/cashoutresult.md +++ b/docs/api/interfaces/cashoutresult.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:104](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L104) +[bee-js/src/types/debug.ts:104](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L104) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:103](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L103) +[bee-js/src/types/debug.ts:103](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L103) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:102](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L102) +[bee-js/src/types/debug.ts:102](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L102) diff --git a/docs/api/interfaces/chainstate.md b/docs/api/interfaces/chainstate.md index 9c3d4bb0..874eece0 100644 --- a/docs/api/interfaces/chainstate.md +++ b/docs/api/interfaces/chainstate.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:201](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L201) +[bee-js/src/types/debug.ts:201](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L201) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:203](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L203) +[bee-js/src/types/debug.ts:203](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L203) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:202](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L202) +[bee-js/src/types/debug.ts:202](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L202) diff --git a/docs/api/interfaces/cheque.md b/docs/api/interfaces/cheque.md index c4778ec8..dc5b5f98 100644 --- a/docs/api/interfaces/cheque.md +++ b/docs/api/interfaces/cheque.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:120](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L120) +[bee-js/src/types/debug.ts:120](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L120) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:121](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L121) +[bee-js/src/types/debug.ts:121](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L121) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:122](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L122) +[bee-js/src/types/debug.ts:122](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L122) diff --git a/docs/api/interfaces/chequebookaddressresponse.md b/docs/api/interfaces/chequebookaddressresponse.md index 26dbb750..8739c645 100644 --- a/docs/api/interfaces/chequebookaddressresponse.md +++ b/docs/api/interfaces/chequebookaddressresponse.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:81](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L81) +[bee-js/src/types/debug.ts:81](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L81) diff --git a/docs/api/interfaces/chequebookbalanceresponse.md b/docs/api/interfaces/chequebookbalanceresponse.md index 840758c7..1ba89186 100644 --- a/docs/api/interfaces/chequebookbalanceresponse.md +++ b/docs/api/interfaces/chequebookbalanceresponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:86](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L86) +[bee-js/src/types/debug.ts:86](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L86) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:85](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L85) +[bee-js/src/types/debug.ts:85](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L85) diff --git a/docs/api/interfaces/collectionentry.md b/docs/api/interfaces/collectionentry.md index 6ab9b6f4..c5e4721e 100644 --- a/docs/api/interfaces/collectionentry.md +++ b/docs/api/interfaces/collectionentry.md @@ -22,7 +22,7 @@ Object represents a file and some of its metadata in [[Directory]] object. #### Defined in -[bee-js/src/types/index.ts:225](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L225) +[bee-js/src/types/index.ts:225](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L225) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:230](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L230) +[bee-js/src/types/index.ts:230](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L230) diff --git a/docs/api/interfaces/collectionuploadoptions.md b/docs/api/interfaces/collectionuploadoptions.md index 860b0231..e62a5129 100644 --- a/docs/api/interfaces/collectionuploadoptions.md +++ b/docs/api/interfaces/collectionuploadoptions.md @@ -26,7 +26,7 @@ Alter default options of axios HTTP client #### Defined in -[bee-js/src/types/index.ts:102](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L102) +[bee-js/src/types/index.ts:102](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L102) ___ @@ -50,7 +50,7 @@ Will encrypt the uploaded data and return longer hash which also includes the de #### Defined in -[bee-js/src/types/index.ts:90](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L90) +[bee-js/src/types/index.ts:90](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L90) ___ @@ -66,7 +66,7 @@ Configure custom error document to be returned when a specified path can not be #### Defined in -[bee-js/src/types/index.ts:136](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L136) +[bee-js/src/types/index.ts:136](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L136) ___ @@ -82,7 +82,7 @@ Default file to be returned when the root hash of collection is accessed. #### Defined in -[bee-js/src/types/index.ts:128](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L128) +[bee-js/src/types/index.ts:128](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L128) ___ @@ -106,7 +106,7 @@ Locally pinned data is possible to reupload to network if it disappear. #### Defined in -[bee-js/src/types/index.ts:79](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L79) +[bee-js/src/types/index.ts:79](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L79) ___ @@ -128,4 +128,4 @@ Tags keep track of syncing the data with network. This option allows attach exis #### Defined in -[bee-js/src/types/index.ts:99](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L99) +[bee-js/src/types/index.ts:99](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L99) diff --git a/docs/api/interfaces/data.md b/docs/api/interfaces/data.md index 116bca94..6fcecb0c 100644 --- a/docs/api/interfaces/data.md +++ b/docs/api/interfaces/data.md @@ -358,7 +358,7 @@ Converts the binary data into hex-string. #### Defined in -[bee-js/src/types/index.ts:213](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L213) +[bee-js/src/types/index.ts:213](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L213) ___ @@ -454,7 +454,7 @@ Converts the binary data into string which is then parsed into JSON. #### Defined in -[bee-js/src/types/index.ts:218](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L218) +[bee-js/src/types/index.ts:218](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L218) ___ @@ -860,7 +860,7 @@ Converts the binary data using UTF-8 decoding into string. #### Defined in -[bee-js/src/types/index.ts:208](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L208) +[bee-js/src/types/index.ts:208](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L208) ___ diff --git a/docs/api/interfaces/debugpostagebatch.md b/docs/api/interfaces/debugpostagebatch.md new file mode 100644 index 00000000..15b8e6b3 --- /dev/null +++ b/docs/api/interfaces/debugpostagebatch.md @@ -0,0 +1,161 @@ +--- +id: "debugpostagebatch" +title: "Interface: DebugPostageBatch" +sidebar_label: "DebugPostageBatch" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`PostageBatch`](postagebatch.md) + + ↳ **`DebugPostageBatch`** + +## Properties + +### amount + +• **amount**: `string` + +#### Inherited from + +[PostageBatch](postagebatch.md).[amount](postagebatch.md#amount) + +#### Defined in + +[bee-js/src/types/index.ts:376](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L376) + +___ + +### batchID + +• **batchID**: [`BatchId`](../types/batchid.md) + +#### Inherited from + +[PostageBatch](postagebatch.md).[batchID](postagebatch.md#batchid) + +#### Defined in + +[bee-js/src/types/index.ts:371](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L371) + +___ + +### batchTTL + +• **batchTTL**: `number` + +The time (in seconds) remaining until the batch expires; -1 signals that the batch never expires; 0 signals that the batch has already expired. + +#### Defined in + +[bee-js/src/types/index.ts:386](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L386) + +___ + +### blockNumber + +• **blockNumber**: `number` + +#### Inherited from + +[PostageBatch](postagebatch.md).[blockNumber](postagebatch.md#blocknumber) + +#### Defined in + +[bee-js/src/types/index.ts:378](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L378) + +___ + +### bucketDepth + +• **bucketDepth**: `number` + +#### Inherited from + +[PostageBatch](postagebatch.md).[bucketDepth](postagebatch.md#bucketdepth) + +#### Defined in + +[bee-js/src/types/index.ts:377](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L377) + +___ + +### depth + +• **depth**: `number` + +#### Inherited from + +[PostageBatch](postagebatch.md).[depth](postagebatch.md#depth) + +#### Defined in + +[bee-js/src/types/index.ts:375](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L375) + +___ + +### exists + +• **exists**: `boolean` + +#### Defined in + +[bee-js/src/types/index.ts:388](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L388) + +___ + +### immutableFlag + +• **immutableFlag**: `boolean` + +#### Inherited from + +[PostageBatch](postagebatch.md).[immutableFlag](postagebatch.md#immutableflag) + +#### Defined in + +[bee-js/src/types/index.ts:379](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L379) + +___ + +### label + +• **label**: `string` + +#### Inherited from + +[PostageBatch](postagebatch.md).[label](postagebatch.md#label) + +#### Defined in + +[bee-js/src/types/index.ts:374](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L374) + +___ + +### usable + +• **usable**: `boolean` + +#### Inherited from + +[PostageBatch](postagebatch.md).[usable](postagebatch.md#usable) + +#### Defined in + +[bee-js/src/types/index.ts:373](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L373) + +___ + +### utilization + +• **utilization**: `number` + +#### Inherited from + +[PostageBatch](postagebatch.md).[utilization](postagebatch.md#utilization) + +#### Defined in + +[bee-js/src/types/index.ts:372](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L372) diff --git a/docs/api/interfaces/extendedtag.md b/docs/api/interfaces/extendedtag.md index 6a09f143..70804a1f 100644 --- a/docs/api/interfaces/extendedtag.md +++ b/docs/api/interfaces/extendedtag.md @@ -20,7 +20,7 @@ The associated swarm hash for this tag #### Defined in -[bee-js/src/types/debug.ts:48](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L48) +[bee-js/src/types/debug.ts:48](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L48) ___ @@ -32,7 +32,7 @@ Number of chunks already seen #### Defined in -[bee-js/src/types/debug.ts:23](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L23) +[bee-js/src/types/debug.ts:23](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L23) ___ @@ -44,7 +44,7 @@ Number of chunks sent for push syncing #### Defined in -[bee-js/src/types/debug.ts:33](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L33) +[bee-js/src/types/debug.ts:33](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L33) ___ @@ -56,7 +56,7 @@ Number of chunks already processed by splitter for hashing #### Defined in -[bee-js/src/types/debug.ts:18](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L18) +[bee-js/src/types/debug.ts:18](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L18) ___ @@ -68,7 +68,7 @@ When the upload process started #### Defined in -[bee-js/src/types/debug.ts:53](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L53) +[bee-js/src/types/debug.ts:53](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L53) ___ @@ -80,7 +80,7 @@ Number of chunks already stored locally #### Defined in -[bee-js/src/types/debug.ts:28](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L28) +[bee-js/src/types/debug.ts:28](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L28) ___ @@ -92,7 +92,7 @@ Number of chunks synced with proof #### Defined in -[bee-js/src/types/debug.ts:38](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L38) +[bee-js/src/types/debug.ts:38](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L38) ___ @@ -104,7 +104,7 @@ Number of all chunks that the data will be split into. #### Defined in -[bee-js/src/types/debug.ts:13](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L13) +[bee-js/src/types/debug.ts:13](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L13) ___ @@ -116,4 +116,4 @@ Unique identifier #### Defined in -[bee-js/src/types/debug.ts:43](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L43) +[bee-js/src/types/debug.ts:43](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L43) diff --git a/docs/api/interfaces/feedreader.md b/docs/api/interfaces/feedreader.md index fcad7015..fa95c86f 100644 --- a/docs/api/interfaces/feedreader.md +++ b/docs/api/interfaces/feedreader.md @@ -22,7 +22,7 @@ FeedReader is an interface for downloading feed updates #### Defined in -[bee-js/src/types/index.ts:292](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L292) +[bee-js/src/types/index.ts:292](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L292) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:293](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L293) +[bee-js/src/types/index.ts:293](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L293) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:291](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L291) +[bee-js/src/types/index.ts:291](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L291) ## Methods @@ -64,4 +64,4 @@ Download the latest feed update #### Defined in -[bee-js/src/types/index.ts:297](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L297) +[bee-js/src/types/index.ts:297](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L297) diff --git a/docs/api/interfaces/feedwriter.md b/docs/api/interfaces/feedwriter.md index bee7c9b7..cd92011f 100644 --- a/docs/api/interfaces/feedwriter.md +++ b/docs/api/interfaces/feedwriter.md @@ -26,7 +26,7 @@ FeedWriter is an interface for updating feeds #### Defined in -[bee-js/src/types/index.ts:292](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L292) +[bee-js/src/types/index.ts:292](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L292) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:293](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L293) +[bee-js/src/types/index.ts:293](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L293) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:291](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L291) +[bee-js/src/types/index.ts:291](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L291) ## Methods @@ -80,7 +80,7 @@ Download the latest feed update #### Defined in -[bee-js/src/types/index.ts:297](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L297) +[bee-js/src/types/index.ts:297](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L297) ___ @@ -106,4 +106,4 @@ Reference that points at Single Owner Chunk that contains the new update and poi #### Defined in -[bee-js/src/types/index.ts:329](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L329) +[bee-js/src/types/index.ts:329](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L329) diff --git a/docs/api/interfaces/filedata.md b/docs/api/interfaces/filedata.md index 0ef611ce..daf0677b 100644 --- a/docs/api/interfaces/filedata.md +++ b/docs/api/interfaces/filedata.md @@ -30,7 +30,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:186](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L186) +[bee-js/src/types/index.ts:186](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L186) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:190](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L190) +[bee-js/src/types/index.ts:190](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L190) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:184](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L184) +[bee-js/src/types/index.ts:184](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L184) ___ @@ -68,4 +68,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:185](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L185) +[bee-js/src/types/index.ts:185](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L185) diff --git a/docs/api/interfaces/fileheaders.md b/docs/api/interfaces/fileheaders.md index abab81df..f59f4378 100644 --- a/docs/api/interfaces/fileheaders.md +++ b/docs/api/interfaces/fileheaders.md @@ -20,7 +20,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:186](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L186) +[bee-js/src/types/index.ts:186](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L186) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:184](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L184) +[bee-js/src/types/index.ts:184](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L184) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:185](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L185) +[bee-js/src/types/index.ts:185](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L185) diff --git a/docs/api/interfaces/fileuploadoptions.md b/docs/api/interfaces/fileuploadoptions.md index 3cf7cbd6..4fe1907d 100644 --- a/docs/api/interfaces/fileuploadoptions.md +++ b/docs/api/interfaces/fileuploadoptions.md @@ -26,7 +26,7 @@ Alter default options of axios HTTP client #### Defined in -[bee-js/src/types/index.ts:102](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L102) +[bee-js/src/types/index.ts:102](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L102) ___ @@ -40,7 +40,7 @@ Specifies given Content-Type so when loaded in browser the file is correctly rep #### Defined in -[bee-js/src/types/index.ts:118](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L118) +[bee-js/src/types/index.ts:118](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L118) ___ @@ -64,7 +64,7 @@ Will encrypt the uploaded data and return longer hash which also includes the de #### Defined in -[bee-js/src/types/index.ts:90](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L90) +[bee-js/src/types/index.ts:90](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L90) ___ @@ -88,7 +88,7 @@ Locally pinned data is possible to reupload to network if it disappear. #### Defined in -[bee-js/src/types/index.ts:79](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L79) +[bee-js/src/types/index.ts:79](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L79) ___ @@ -102,7 +102,7 @@ Specifies Content-Length for the given data. It is required when uploading with #### Defined in -[bee-js/src/types/index.ts:111](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L111) +[bee-js/src/types/index.ts:111](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L111) ___ @@ -124,4 +124,4 @@ Tags keep track of syncing the data with network. This option allows attach exis #### Defined in -[bee-js/src/types/index.ts:99](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L99) +[bee-js/src/types/index.ts:99](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L99) diff --git a/docs/api/interfaces/health.md b/docs/api/interfaces/health.md index 30bd9526..deceb6cb 100644 --- a/docs/api/interfaces/health.md +++ b/docs/api/interfaces/health.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:145](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L145) +[bee-js/src/types/debug.ts:145](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L145) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:146](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L146) +[bee-js/src/types/debug.ts:146](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L146) diff --git a/docs/api/interfaces/jsonfeedoptions.md b/docs/api/interfaces/jsonfeedoptions.md index 17dd15fd..d4d71cc2 100644 --- a/docs/api/interfaces/jsonfeedoptions.md +++ b/docs/api/interfaces/jsonfeedoptions.md @@ -17,7 +17,7 @@ to be specified. #### Defined in -[bee-js/src/types/index.ts:305](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L305) +[bee-js/src/types/index.ts:305](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L305) ___ @@ -31,7 +31,7 @@ if not specified for `get` then `address` option has to be specified. #### Defined in -[bee-js/src/types/index.ts:312](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L312) +[bee-js/src/types/index.ts:312](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L312) ___ @@ -41,4 +41,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:313](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L313) +[bee-js/src/types/index.ts:313](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L313) diff --git a/docs/api/interfaces/lastcashoutactionresponse.md b/docs/api/interfaces/lastcashoutactionresponse.md index 4eb962fb..8c62e7e8 100644 --- a/docs/api/interfaces/lastcashoutactionresponse.md +++ b/docs/api/interfaces/lastcashoutactionresponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:111](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L111) +[bee-js/src/types/debug.ts:111](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L111) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:108](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L108) +[bee-js/src/types/debug.ts:108](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L108) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:112](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L112) +[bee-js/src/types/debug.ts:112](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L112) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:110](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L110) +[bee-js/src/types/debug.ts:110](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L110) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:109](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L109) +[bee-js/src/types/debug.ts:109](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L109) diff --git a/docs/api/interfaces/lastchequesforpeerresponse.md b/docs/api/interfaces/lastchequesforpeerresponse.md index 348dde74..8f75bc7f 100644 --- a/docs/api/interfaces/lastchequesforpeerresponse.md +++ b/docs/api/interfaces/lastchequesforpeerresponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:127](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L127) +[bee-js/src/types/debug.ts:127](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L127) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:128](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L128) +[bee-js/src/types/debug.ts:128](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L128) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:126](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L126) +[bee-js/src/types/debug.ts:126](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L126) diff --git a/docs/api/interfaces/lastchequesresponse.md b/docs/api/interfaces/lastchequesresponse.md index 469df75b..9def7f29 100644 --- a/docs/api/interfaces/lastchequesresponse.md +++ b/docs/api/interfaces/lastchequesresponse.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:132](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L132) +[bee-js/src/types/debug.ts:132](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L132) diff --git a/docs/api/interfaces/nodeaddresses.md b/docs/api/interfaces/nodeaddresses.md index 77d8ca75..7c0867c2 100644 --- a/docs/api/interfaces/nodeaddresses.md +++ b/docs/api/interfaces/nodeaddresses.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:71](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L71) +[bee-js/src/types/debug.ts:71](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L71) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:69](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L69) +[bee-js/src/types/debug.ts:69](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L69) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:73](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L73) +[bee-js/src/types/debug.ts:73](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L73) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:72](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L72) +[bee-js/src/types/debug.ts:72](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L72) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:70](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L70) +[bee-js/src/types/debug.ts:70](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L70) diff --git a/docs/api/interfaces/peer.md b/docs/api/interfaces/peer.md index 6a9aec33..96d9c305 100644 --- a/docs/api/interfaces/peer.md +++ b/docs/api/interfaces/peer.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:77](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L77) +[bee-js/src/types/debug.ts:77](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L77) diff --git a/docs/api/interfaces/peerbalance.md b/docs/api/interfaces/peerbalance.md index 52fcc60a..9d0a65a3 100644 --- a/docs/api/interfaces/peerbalance.md +++ b/docs/api/interfaces/peerbalance.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:137](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L137) +[bee-js/src/types/debug.ts:137](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L137) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:136](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L136) +[bee-js/src/types/debug.ts:136](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L136) diff --git a/docs/api/interfaces/pin.md b/docs/api/interfaces/pin.md index 7221adbe..4761a148 100644 --- a/docs/api/interfaces/pin.md +++ b/docs/api/interfaces/pin.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:194](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L194) +[bee-js/src/types/index.ts:194](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L194) diff --git a/docs/api/interfaces/pingresponse.md b/docs/api/interfaces/pingresponse.md index 590f5c0d..59a3e502 100644 --- a/docs/api/interfaces/pingresponse.md +++ b/docs/api/interfaces/pingresponse.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:189](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L189) +[bee-js/src/types/debug.ts:189](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L189) diff --git a/docs/api/interfaces/postagebatch.md b/docs/api/interfaces/postagebatch.md index 8e428fc5..86d90508 100644 --- a/docs/api/interfaces/postagebatch.md +++ b/docs/api/interfaces/postagebatch.md @@ -8,6 +8,12 @@ custom_edit_url: null Interface representing Postage stamp batch. +## Hierarchy + +- **`PostageBatch`** + + ↳ [`DebugPostageBatch`](debugpostagebatch.md) + ## Properties ### amount @@ -16,7 +22,7 @@ Interface representing Postage stamp batch. #### Defined in -[bee-js/src/types/index.ts:376](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L376) +[bee-js/src/types/index.ts:376](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L376) ___ @@ -26,7 +32,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:371](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L371) +[bee-js/src/types/index.ts:371](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L371) ___ @@ -36,7 +42,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:378](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L378) +[bee-js/src/types/index.ts:378](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L378) ___ @@ -46,7 +52,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:377](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L377) +[bee-js/src/types/index.ts:377](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L377) ___ @@ -56,7 +62,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:375](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L375) +[bee-js/src/types/index.ts:375](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L375) ___ @@ -66,7 +72,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:379](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L379) +[bee-js/src/types/index.ts:379](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L379) ___ @@ -76,7 +82,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:374](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L374) +[bee-js/src/types/index.ts:374](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L374) ___ @@ -86,7 +92,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:373](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L373) +[bee-js/src/types/index.ts:373](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L373) ___ @@ -96,4 +102,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:372](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L372) +[bee-js/src/types/index.ts:372](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L372) diff --git a/docs/api/interfaces/postagebatchbuckets.md b/docs/api/interfaces/postagebatchbuckets.md new file mode 100644 index 00000000..ac9c7494 --- /dev/null +++ b/docs/api/interfaces/postagebatchbuckets.md @@ -0,0 +1,47 @@ +--- +id: "postagebatchbuckets" +title: "Interface: PostageBatchBuckets" +sidebar_label: "PostageBatchBuckets" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### bucketDepth + +• **bucketDepth**: `number` + +#### Defined in + +[bee-js/src/types/index.ts:398](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L398) + +___ + +### bucketUpperBound + +• **bucketUpperBound**: `number` + +#### Defined in + +[bee-js/src/types/index.ts:399](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L399) + +___ + +### buckets + +• `Optional` **buckets**: [`BatchBucket`](batchbucket.md)[] + +#### Defined in + +[bee-js/src/types/index.ts:400](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L400) + +___ + +### depth + +• **depth**: `number` + +#### Defined in + +[bee-js/src/types/index.ts:397](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L397) diff --git a/docs/api/interfaces/postagebatchoptions.md b/docs/api/interfaces/postagebatchoptions.md index ee11b50e..aa5de4bd 100644 --- a/docs/api/interfaces/postagebatchoptions.md +++ b/docs/api/interfaces/postagebatchoptions.md @@ -18,7 +18,7 @@ Sets gas price in Wei for the transaction that creates the postage batch #### Defined in -[bee-js/src/types/index.ts:394](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L394) +[bee-js/src/types/index.ts:429](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L429) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:395](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L395) +[bee-js/src/types/index.ts:430](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L430) ___ @@ -40,4 +40,4 @@ Sets label for the postage batch #### Defined in -[bee-js/src/types/index.ts:389](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L389) +[bee-js/src/types/index.ts:424](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L424) diff --git a/docs/api/interfaces/pssmessagehandler.md b/docs/api/interfaces/pssmessagehandler.md index 2c3a18a1..7ccc8de9 100644 --- a/docs/api/interfaces/pssmessagehandler.md +++ b/docs/api/interfaces/pssmessagehandler.md @@ -29,7 +29,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:245](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L245) +[bee-js/src/types/index.ts:245](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L245) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:244](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L244) +[bee-js/src/types/index.ts:244](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L244) diff --git a/docs/api/interfaces/psssubscription.md b/docs/api/interfaces/psssubscription.md index 651d6445..97187fca 100644 --- a/docs/api/interfaces/psssubscription.md +++ b/docs/api/interfaces/psssubscription.md @@ -22,7 +22,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:240](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L240) +[bee-js/src/types/index.ts:240](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L240) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:239](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L239) +[bee-js/src/types/index.ts:239](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L239) diff --git a/docs/api/interfaces/referenceresponse.md b/docs/api/interfaces/referenceresponse.md index b87a1fdd..90fc010b 100644 --- a/docs/api/interfaces/referenceresponse.md +++ b/docs/api/interfaces/referenceresponse.md @@ -14,4 +14,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:254](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L254) +[bee-js/src/types/index.ts:254](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L254) diff --git a/docs/api/interfaces/removepeerresponse.md b/docs/api/interfaces/removepeerresponse.md index f705bbe4..86be7107 100644 --- a/docs/api/interfaces/removepeerresponse.md +++ b/docs/api/interfaces/removepeerresponse.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:151](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L151) +[bee-js/src/types/debug.ts:151](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L151) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:150](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L150) +[bee-js/src/types/debug.ts:150](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L150) diff --git a/docs/api/interfaces/reservestate.md b/docs/api/interfaces/reservestate.md index 0a5b9356..3856396f 100644 --- a/docs/api/interfaces/reservestate.md +++ b/docs/api/interfaces/reservestate.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:195](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L195) +[bee-js/src/types/debug.ts:195](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L195) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:197](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L197) +[bee-js/src/types/debug.ts:197](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L197) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:196](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L196) +[bee-js/src/types/debug.ts:196](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L196) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:193](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L193) +[bee-js/src/types/debug.ts:193](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L193) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:194](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L194) +[bee-js/src/types/debug.ts:194](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L194) diff --git a/docs/api/interfaces/settlements.md b/docs/api/interfaces/settlements.md index 12a3fcef..1c52057b 100644 --- a/docs/api/interfaces/settlements.md +++ b/docs/api/interfaces/settlements.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:57](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L57) +[bee-js/src/types/debug.ts:57](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L57) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:58](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L58) +[bee-js/src/types/debug.ts:58](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L58) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:59](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L59) +[bee-js/src/types/debug.ts:59](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L59) diff --git a/docs/api/interfaces/socreader.md b/docs/api/interfaces/socreader.md index b5831cac..3708210e 100644 --- a/docs/api/interfaces/socreader.md +++ b/docs/api/interfaces/socreader.md @@ -38,4 +38,4 @@ Downloads a single owner chunk #### Defined in -[bee-js/src/types/index.ts:345](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L345) +[bee-js/src/types/index.ts:345](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L345) diff --git a/docs/api/interfaces/socwriter.md b/docs/api/interfaces/socwriter.md index 5076ad14..953ad6ce 100644 --- a/docs/api/interfaces/socwriter.md +++ b/docs/api/interfaces/socwriter.md @@ -42,7 +42,7 @@ Downloads a single owner chunk #### Defined in -[bee-js/src/types/index.ts:345](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L345) +[bee-js/src/types/index.ts:345](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L345) ___ @@ -71,4 +71,4 @@ Uploads a single owner chunk #### Defined in -[bee-js/src/types/index.ts:359](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L359) +[bee-js/src/types/index.ts:359](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L359) diff --git a/docs/api/interfaces/tag.md b/docs/api/interfaces/tag.md index ed39681c..8277a0a3 100644 --- a/docs/api/interfaces/tag.md +++ b/docs/api/interfaces/tag.md @@ -20,7 +20,7 @@ Number of chunks that is locally stored in the Bee node. #### Defined in -[bee-js/src/types/index.ts:160](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L160) +[bee-js/src/types/index.ts:160](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L160) ___ @@ -32,7 +32,7 @@ When the upload process started #### Defined in -[bee-js/src/types/index.ts:175](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L175) +[bee-js/src/types/index.ts:175](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L175) ___ @@ -44,7 +44,7 @@ Number of chunks that arrived to their designated destination in the network #### Defined in -[bee-js/src/types/index.ts:165](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L165) +[bee-js/src/types/index.ts:165](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L165) ___ @@ -56,7 +56,7 @@ Number of all chunks that the data will be split into. #### Defined in -[bee-js/src/types/index.ts:155](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L155) +[bee-js/src/types/index.ts:155](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L155) ___ @@ -68,4 +68,4 @@ Unique identifier #### Defined in -[bee-js/src/types/index.ts:170](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L170) +[bee-js/src/types/index.ts:170](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L170) diff --git a/docs/api/interfaces/topology.md b/docs/api/interfaces/topology.md index 0ad306d2..b983cb04 100644 --- a/docs/api/interfaces/topology.md +++ b/docs/api/interfaces/topology.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/debug.ts:162](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L162) +[bee-js/src/types/debug.ts:162](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L162) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:168](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L168) +[bee-js/src/types/debug.ts:168](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L168) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:164](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L164) +[bee-js/src/types/debug.ts:164](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L164) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:167](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L167) +[bee-js/src/types/debug.ts:167](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L167) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:166](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L166) +[bee-js/src/types/debug.ts:166](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L166) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:163](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L163) +[bee-js/src/types/debug.ts:163](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L163) ___ @@ -95,4 +95,4 @@ ___ #### Defined in -[bee-js/src/types/debug.ts:165](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L165) +[bee-js/src/types/debug.ts:165](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L165) diff --git a/docs/api/interfaces/transactioninfo.md b/docs/api/interfaces/transactioninfo.md new file mode 100644 index 00000000..21ad8caf --- /dev/null +++ b/docs/api/interfaces/transactioninfo.md @@ -0,0 +1,97 @@ +--- +id: "transactioninfo" +title: "Interface: TransactionInfo" +sidebar_label: "TransactionInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### created + +• **created**: `string` + +#### Defined in + +[bee-js/src/types/index.ts:412](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L412) + +___ + +### data + +• **data**: `string` + +#### Defined in + +[bee-js/src/types/index.ts:411](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L411) + +___ + +### description + +• **description**: `string` + +#### Defined in + +[bee-js/src/types/index.ts:413](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L413) + +___ + +### gasLimit + +• **gasLimit**: `number` + +#### Defined in + +[bee-js/src/types/index.ts:410](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L410) + +___ + +### gasPrice + +• **gasPrice**: [`NumberString`](../types/numberstring.md) + +#### Defined in + +[bee-js/src/types/index.ts:409](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L409) + +___ + +### nonce + +• **nonce**: `number` + +#### Defined in + +[bee-js/src/types/index.ts:408](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L408) + +___ + +### to + +• **to**: [`HexEthAddress`](../types/utils.eth.hexethaddress.md) + +#### Defined in + +[bee-js/src/types/index.ts:407](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L407) + +___ + +### transactionHash + +• **transactionHash**: [`TransactionHash`](../types/transactionhash.md) + +#### Defined in + +[bee-js/src/types/index.ts:406](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L406) + +___ + +### value + +• **value**: `string` + +#### Defined in + +[bee-js/src/types/index.ts:414](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L414) diff --git a/docs/api/interfaces/transactionresponse.md b/docs/api/interfaces/transactionresponse.md index e03b6f30..6252e815 100644 --- a/docs/api/interfaces/transactionresponse.md +++ b/docs/api/interfaces/transactionresponse.md @@ -10,8 +10,8 @@ custom_edit_url: null ### transactionHash -• **transactionHash**: `string` +• **transactionHash**: [`TransactionHash`](../types/transactionhash.md) #### Defined in -[bee-js/src/types/debug.ts:116](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/debug.ts#L116) +[bee-js/src/types/debug.ts:116](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/debug.ts#L116) diff --git a/docs/api/interfaces/uploadheaders.md b/docs/api/interfaces/uploadheaders.md index 932ea249..a960739e 100644 --- a/docs/api/interfaces/uploadheaders.md +++ b/docs/api/interfaces/uploadheaders.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:140](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L140) +[bee-js/src/types/index.ts:140](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L140) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:139](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L139) +[bee-js/src/types/index.ts:139](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L139) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bee-js/src/types/index.ts:142](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L142) +[bee-js/src/types/index.ts:142](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L142) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[bee-js/src/types/index.ts:141](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L141) +[bee-js/src/types/index.ts:141](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L141) diff --git a/docs/api/interfaces/uploadoptions.md b/docs/api/interfaces/uploadoptions.md index 078f3578..1bd8db3d 100644 --- a/docs/api/interfaces/uploadoptions.md +++ b/docs/api/interfaces/uploadoptions.md @@ -24,7 +24,7 @@ Alter default options of axios HTTP client #### Defined in -[bee-js/src/types/index.ts:102](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L102) +[bee-js/src/types/index.ts:102](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L102) ___ @@ -44,7 +44,7 @@ Will encrypt the uploaded data and return longer hash which also includes the de #### Defined in -[bee-js/src/types/index.ts:90](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L90) +[bee-js/src/types/index.ts:90](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L90) ___ @@ -64,7 +64,7 @@ Locally pinned data is possible to reupload to network if it disappear. #### Defined in -[bee-js/src/types/index.ts:79](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L79) +[bee-js/src/types/index.ts:79](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L79) ___ @@ -82,4 +82,4 @@ Tags keep track of syncing the data with network. This option allows attach exis #### Defined in -[bee-js/src/types/index.ts:99](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L99) +[bee-js/src/types/index.ts:99](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L99) diff --git a/docs/api/interfaces/utils.bytes.bytes.md b/docs/api/interfaces/utils.bytes.bytes.md index 070ca54a..4dc4fd2c 100644 --- a/docs/api/interfaces/utils.bytes.bytes.md +++ b/docs/api/interfaces/utils.bytes.bytes.md @@ -109,7 +109,7 @@ Uint8Array.length #### Defined in -[bee-js/src/utils/bytes.ts:12](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L12) +[bee-js/src/utils/bytes.ts:12](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L12) ## Methods diff --git a/docs/api/interfaces/utils.bytes.flexbytes.md b/docs/api/interfaces/utils.bytes.flexbytes.md index ed9171cb..86541966 100644 --- a/docs/api/interfaces/utils.bytes.flexbytes.md +++ b/docs/api/interfaces/utils.bytes.flexbytes.md @@ -66,7 +66,7 @@ ___ #### Defined in -[bee-js/src/utils/bytes.ts:25](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L25) +[bee-js/src/utils/bytes.ts:25](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L25) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[bee-js/src/utils/bytes.ts:24](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/bytes.ts#L24) +[bee-js/src/utils/bytes.ts:24](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/bytes.ts#L24) ___ diff --git a/docs/api/interfaces/utils.eth.jsonrpc.md b/docs/api/interfaces/utils.eth.jsonrpc.md index f9f4c3fe..525433f9 100644 --- a/docs/api/interfaces/utils.eth.jsonrpc.md +++ b/docs/api/interfaces/utils.eth.jsonrpc.md @@ -25,7 +25,7 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/eth.ts:181](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L181) +[bee-js/src/utils/eth.ts:181](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L181) ___ @@ -45,4 +45,4 @@ ___ #### Defined in -[bee-js/src/utils/eth.ts:182](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L182) +[bee-js/src/utils/eth.ts:182](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L182) diff --git a/docs/api/types/address.md b/docs/api/types/address.md index 152108d6..41d0582a 100644 --- a/docs/api/types/address.md +++ b/docs/api/types/address.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:48](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L48) +[bee-js/src/types/index.ts:48](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L48) diff --git a/docs/api/types/addressprefix.md b/docs/api/types/addressprefix.md index 6327b808..527dd34f 100644 --- a/docs/api/types/addressprefix.md +++ b/docs/api/types/addressprefix.md @@ -13,4 +13,4 @@ It represents PSS Address Prefix that is used to define address neighborhood tha #### Defined in -[bee-js/src/types/index.ts:59](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L59) +[bee-js/src/types/index.ts:59](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L59) diff --git a/docs/api/types/anyjson.md b/docs/api/types/anyjson.md index 83d028e1..40e1192a 100644 --- a/docs/api/types/anyjson.md +++ b/docs/api/types/anyjson.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:458](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L458) +[bee-js/src/types/index.ts:493](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L493) diff --git a/docs/api/types/batchid.md b/docs/api/types/batchid.md index f3598cc5..9c14e965 100644 --- a/docs/api/types/batchid.md +++ b/docs/api/types/batchid.md @@ -12,4 +12,4 @@ BatchId is result of keccak256 hash so 64 hex string without prefix. #### Defined in -[bee-js/src/types/index.ts:53](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L53) +[bee-js/src/types/index.ts:53](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L53) diff --git a/docs/api/types/brandedstring.md b/docs/api/types/brandedstring.md index 9ad8d80e..4332f4fd 100644 --- a/docs/api/types/brandedstring.md +++ b/docs/api/types/brandedstring.md @@ -16,4 +16,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:452](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L452) +[bee-js/src/types/index.ts:487](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L487) diff --git a/docs/api/types/brandedtype.md b/docs/api/types/brandedtype.md index acc53466..c4d9c29e 100644 --- a/docs/api/types/brandedtype.md +++ b/docs/api/types/brandedtype.md @@ -21,4 +21,4 @@ See https://spin.atomicobject.com/2018/01/15/typescript-flexible-nominal-typing/ #### Defined in -[bee-js/src/types/index.ts:450](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L450) +[bee-js/src/types/index.ts:485](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L485) diff --git a/docs/api/types/collection.md b/docs/api/types/collection.md index c9e7de4b..4c149b4e 100644 --- a/docs/api/types/collection.md +++ b/docs/api/types/collection.md @@ -18,4 +18,4 @@ Represents Collections #### Defined in -[bee-js/src/types/index.ts:236](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L236) +[bee-js/src/types/index.ts:236](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L236) diff --git a/docs/api/types/flavoredtype.md b/docs/api/types/flavoredtype.md index 3a491923..8a12bf3c 100644 --- a/docs/api/types/flavoredtype.md +++ b/docs/api/types/flavoredtype.md @@ -17,4 +17,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:454](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L454) +[bee-js/src/types/index.ts:489](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L489) diff --git a/docs/api/types/httpmethod.md b/docs/api/types/httpmethod.md index a5386572..fb27019c 100644 --- a/docs/api/types/httpmethod.md +++ b/docs/api/types/httpmethod.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:257](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L257) +[bee-js/src/types/index.ts:257](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L257) diff --git a/docs/api/types/numberstring.md b/docs/api/types/numberstring.md index 007f1e89..c1a9864c 100644 --- a/docs/api/types/numberstring.md +++ b/docs/api/types/numberstring.md @@ -12,4 +12,4 @@ With this type a number should be represented in a string #### Defined in -[bee-js/src/types/index.ts:401](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L401) +[bee-js/src/types/index.ts:436](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L436) diff --git a/docs/api/types/privatekeybytes.md b/docs/api/types/privatekeybytes.md index ab0a2306..e57525e9 100644 --- a/docs/api/types/privatekeybytes.md +++ b/docs/api/types/privatekeybytes.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:411](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L411) +[bee-js/src/types/index.ts:446](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L446) diff --git a/docs/api/types/publickey.md b/docs/api/types/publickey.md index fb6ee1a5..29478395 100644 --- a/docs/api/types/publickey.md +++ b/docs/api/types/publickey.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:46](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L46) +[bee-js/src/types/index.ts:46](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L46) diff --git a/docs/api/types/reference.md b/docs/api/types/reference.md index 6d3d43ef..b71a0776 100644 --- a/docs/api/types/reference.md +++ b/docs/api/types/reference.md @@ -17,4 +17,4 @@ Encrypted reference consists of two parts. The reference address itself (like no #### Defined in -[bee-js/src/types/index.ts:45](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L45) +[bee-js/src/types/index.ts:45](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L45) diff --git a/docs/api/types/signature.md b/docs/api/types/signature.md index 85091fd0..6389fb14 100644 --- a/docs/api/types/signature.md +++ b/docs/api/types/signature.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:410](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L410) +[bee-js/src/types/index.ts:445](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L445) diff --git a/docs/api/types/signer.md b/docs/api/types/signer.md index 4e6ef168..af9248a3 100644 --- a/docs/api/types/signer.md +++ b/docs/api/types/signer.md @@ -35,4 +35,4 @@ For example see the hashWithEthereumPrefix() function. #### Defined in -[bee-js/src/types/index.ts:440](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L440) +[bee-js/src/types/index.ts:475](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L475) diff --git a/docs/api/types/topic.md b/docs/api/types/topic.md index f66b2246..d582b0dd 100644 --- a/docs/api/types/topic.md +++ b/docs/api/types/topic.md @@ -12,4 +12,4 @@ Hex string of length 64 chars without prefix that specifies topics for feed. #### Defined in -[bee-js/src/types/index.ts:285](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L285) +[bee-js/src/types/index.ts:285](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L285) diff --git a/docs/api/types/transactionhash.md b/docs/api/types/transactionhash.md new file mode 100644 index 00000000..b75ea3e5 --- /dev/null +++ b/docs/api/types/transactionhash.md @@ -0,0 +1,13 @@ +--- +id: "transactionhash" +title: "Type alias: TransactionHash" +sidebar_label: "TransactionHash" +sidebar_position: 0 +custom_edit_url: null +--- + +Ƭ **TransactionHash**: [`BrandedString`](brandedstring.md)<``"TransactionHash"``\> + +#### Defined in + +[bee-js/src/types/index.ts:403](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L403) diff --git a/docs/api/types/utils.eth.ethaddress.md b/docs/api/types/utils.eth.ethaddress.md index 1744e46f..1129d773 100644 --- a/docs/api/types/utils.eth.ethaddress.md +++ b/docs/api/types/utils.eth.ethaddress.md @@ -11,4 +11,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/eth.ts:7](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L7) +[bee-js/src/utils/eth.ts:7](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L7) diff --git a/docs/api/types/utils.eth.hexethaddress.md b/docs/api/types/utils.eth.hexethaddress.md index 4c1d06fb..fab261ac 100644 --- a/docs/api/types/utils.eth.hexethaddress.md +++ b/docs/api/types/utils.eth.hexethaddress.md @@ -11,4 +11,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/eth.ts:8](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L8) +[bee-js/src/utils/eth.ts:8](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L8) diff --git a/docs/api/types/utils.eth.overlayaddress.md b/docs/api/types/utils.eth.overlayaddress.md index 9efacaff..327601fb 100644 --- a/docs/api/types/utils.eth.overlayaddress.md +++ b/docs/api/types/utils.eth.overlayaddress.md @@ -11,4 +11,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/utils/eth.ts:6](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/eth.ts#L6) +[bee-js/src/utils/eth.ts:6](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/eth.ts#L6) diff --git a/docs/api/types/utils.hex.hexstring.md b/docs/api/types/utils.hex.hexstring.md index 46c2d182..9acf2e48 100644 --- a/docs/api/types/utils.hex.hexstring.md +++ b/docs/api/types/utils.hex.hexstring.md @@ -21,4 +21,4 @@ TODO: Make Length mandatory: https://github.com/ethersphere/bee-js/issues/208 #### Defined in -[bee-js/src/utils/hex.ts:9](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L9) +[bee-js/src/utils/hex.ts:9](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L9) diff --git a/docs/api/types/utils.hex.prefixedhexstring.md b/docs/api/types/utils.hex.prefixedhexstring.md index a81c9d7b..a3329c9e 100644 --- a/docs/api/types/utils.hex.prefixedhexstring.md +++ b/docs/api/types/utils.hex.prefixedhexstring.md @@ -17,4 +17,4 @@ should be validated and converted to HexString ASAP. #### Defined in -[bee-js/src/utils/hex.ts:23](https://github.com/ethersphere/bee-js/blob/6f227e1/src/utils/hex.ts#L23) +[bee-js/src/utils/hex.ts:23](https://github.com/ethersphere/bee-js/blob/74056cb/src/utils/hex.ts#L23) diff --git a/docs/api/variables/address_hex_length.md b/docs/api/variables/address_hex_length.md index cbfb7856..0bfeb066 100644 --- a/docs/api/variables/address_hex_length.md +++ b/docs/api/variables/address_hex_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:16](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L16) +[bee-js/src/types/index.ts:16](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L16) diff --git a/docs/api/variables/batch_id_hex_length.md b/docs/api/variables/batch_id_hex_length.md index 299c06ee..32efbcdb 100644 --- a/docs/api/variables/batch_id_hex_length.md +++ b/docs/api/variables/batch_id_hex_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:18](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L18) +[bee-js/src/types/index.ts:18](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L18) diff --git a/docs/api/variables/encrypted_reference_bytes_length.md b/docs/api/variables/encrypted_reference_bytes_length.md index 70a718ea..42d8f2c4 100644 --- a/docs/api/variables/encrypted_reference_bytes_length.md +++ b/docs/api/variables/encrypted_reference_bytes_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:22](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L22) +[bee-js/src/types/index.ts:22](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L22) diff --git a/docs/api/variables/encrypted_reference_hex_length.md b/docs/api/variables/encrypted_reference_hex_length.md index b96ef73c..8a1e454f 100644 --- a/docs/api/variables/encrypted_reference_hex_length.md +++ b/docs/api/variables/encrypted_reference_hex_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:20](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L20) +[bee-js/src/types/index.ts:20](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L20) diff --git a/docs/api/variables/pubkey_hex_length.md b/docs/api/variables/pubkey_hex_length.md index 085c74f0..a69797c3 100644 --- a/docs/api/variables/pubkey_hex_length.md +++ b/docs/api/variables/pubkey_hex_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:17](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L17) +[bee-js/src/types/index.ts:17](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L17) diff --git a/docs/api/variables/reference_bytes_length.md b/docs/api/variables/reference_bytes_length.md index fcdfe035..a32dd574 100644 --- a/docs/api/variables/reference_bytes_length.md +++ b/docs/api/variables/reference_bytes_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:21](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L21) +[bee-js/src/types/index.ts:21](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L21) diff --git a/docs/api/variables/reference_hex_length.md b/docs/api/variables/reference_hex_length.md index d065018b..3c2f1b74 100644 --- a/docs/api/variables/reference_hex_length.md +++ b/docs/api/variables/reference_hex_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:19](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L19) +[bee-js/src/types/index.ts:19](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L19) diff --git a/docs/api/variables/signature_bytes_length.md b/docs/api/variables/signature_bytes_length.md index eca4be4a..3313a906 100644 --- a/docs/api/variables/signature_bytes_length.md +++ b/docs/api/variables/signature_bytes_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:408](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L408) +[bee-js/src/types/index.ts:443](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L443) diff --git a/docs/api/variables/signature_hex_length.md b/docs/api/variables/signature_hex_length.md index dc14da0d..ce25a9eb 100644 --- a/docs/api/variables/signature_hex_length.md +++ b/docs/api/variables/signature_hex_length.md @@ -12,4 +12,4 @@ Ethereum compatible signing interfaces and definitions #### Defined in -[bee-js/src/types/index.ts:407](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L407) +[bee-js/src/types/index.ts:442](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L442) diff --git a/docs/api/variables/stamps_depth_max.md b/docs/api/variables/stamps_depth_max.md index 1076acaf..6f8ac81e 100644 --- a/docs/api/variables/stamps_depth_max.md +++ b/docs/api/variables/stamps_depth_max.md @@ -12,4 +12,4 @@ Maximal depth that can be used for creation of postage batch #### Defined in -[bee-js/src/types/index.ts:32](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L32) +[bee-js/src/types/index.ts:32](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L32) diff --git a/docs/api/variables/stamps_depth_min.md b/docs/api/variables/stamps_depth_min.md index 6d370ea6..2ff8f9aa 100644 --- a/docs/api/variables/stamps_depth_min.md +++ b/docs/api/variables/stamps_depth_min.md @@ -12,4 +12,4 @@ Minimal depth that can be used for creation of postage batch #### Defined in -[bee-js/src/types/index.ts:27](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L27) +[bee-js/src/types/index.ts:27](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L27) diff --git a/docs/api/variables/supported_bee_version.md b/docs/api/variables/supported_bee_version.md index 731aa9e7..5133ca16 100644 --- a/docs/api/variables/supported_bee_version.md +++ b/docs/api/variables/supported_bee_version.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/modules/debug/status.ts:5](https://github.com/ethersphere/bee-js/blob/6f227e1/src/modules/debug/status.ts#L5) +[bee-js/src/modules/debug/status.ts:5](https://github.com/ethersphere/bee-js/blob/74056cb/src/modules/debug/status.ts#L5) diff --git a/docs/api/variables/supported_bee_version_exact.md b/docs/api/variables/supported_bee_version_exact.md index 81b39f67..f9ac5d04 100644 --- a/docs/api/variables/supported_bee_version_exact.md +++ b/docs/api/variables/supported_bee_version_exact.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/modules/debug/status.ts:4](https://github.com/ethersphere/bee-js/blob/6f227e1/src/modules/debug/status.ts#L4) +[bee-js/src/modules/debug/status.ts:4](https://github.com/ethersphere/bee-js/blob/74056cb/src/modules/debug/status.ts#L4) diff --git a/docs/api/variables/tags_limit_max.md b/docs/api/variables/tags_limit_max.md index 9062edd9..19fd9787 100644 --- a/docs/api/variables/tags_limit_max.md +++ b/docs/api/variables/tags_limit_max.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:35](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L35) +[bee-js/src/types/index.ts:35](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L35) diff --git a/docs/api/variables/tags_limit_min.md b/docs/api/variables/tags_limit_min.md index 535b17c3..af460253 100644 --- a/docs/api/variables/tags_limit_min.md +++ b/docs/api/variables/tags_limit_min.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:34](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L34) +[bee-js/src/types/index.ts:34](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L34) diff --git a/docs/api/variables/topic_bytes_length.md b/docs/api/variables/topic_bytes_length.md index 0dd7cde1..91bfdf8b 100644 --- a/docs/api/variables/topic_bytes_length.md +++ b/docs/api/variables/topic_bytes_length.md @@ -12,4 +12,4 @@ Writers and Readers interfaces #### Defined in -[bee-js/src/types/index.ts:279](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L279) +[bee-js/src/types/index.ts:279](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L279) diff --git a/docs/api/variables/topic_hex_length.md b/docs/api/variables/topic_hex_length.md index 42d03877..811e1178 100644 --- a/docs/api/variables/topic_hex_length.md +++ b/docs/api/variables/topic_hex_length.md @@ -10,4 +10,4 @@ custom_edit_url: null #### Defined in -[bee-js/src/types/index.ts:280](https://github.com/ethersphere/bee-js/blob/6f227e1/src/types/index.ts#L280) +[bee-js/src/types/index.ts:280](https://github.com/ethersphere/bee-js/blob/74056cb/src/types/index.ts#L280)