From 5bf8655f1ca8680b9a775a51488d7bbbbb6e86c3 Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 01:10:08 +0700 Subject: [PATCH 1/8] typedoc docs --- docs/api/Overview.md | 142 + docs/api/classes/BZZ.md | 287 ++ docs/api/classes/BatchId.md | 297 ++ docs/api/classes/Bee.md | 3205 +++++++++++++++ docs/api/classes/BeeArgumentError.md | 47 + docs/api/classes/BeeDev.md | 3621 +++++++++++++++++ docs/api/classes/BeeError.md | 40 + docs/api/classes/BeeResponseError.md | 95 + docs/api/classes/Bytes.md | 244 ++ docs/api/classes/DAI.md | 287 ++ docs/api/classes/Duration.md | 217 + docs/api/classes/EthAddress.md | 309 ++ docs/api/classes/FeedIndex.md | 347 ++ docs/api/classes/Identifier.md | 315 ++ docs/api/classes/MantarayNode.md | 461 +++ docs/api/classes/PeerAddress.md | 297 ++ docs/api/classes/PrivateKey.md | 327 ++ docs/api/classes/PublicKey.md | 333 ++ docs/api/classes/Reference.md | 333 ++ docs/api/classes/Signature.md | 333 ++ docs/api/classes/Size.md | 123 + docs/api/classes/Span.md | 323 ++ docs/api/classes/Stamper.md | 135 + docs/api/classes/Topic.md | 315 ++ docs/api/classes/TransactionId.md | 297 ++ docs/api/enumerations/BeeModes.md | 41 + docs/api/enumerations/RedundancyLevel.md | 52 + docs/api/enumerations/RedundancyStrategy.md | 50 + docs/api/functions/toBeeMode.md | 21 + docs/api/interfaces/AllSettlements.md | 33 + docs/api/interfaces/AllTagsOptions.md | 25 + docs/api/interfaces/BalanceResponse.md | 17 + docs/api/interfaces/BatchBucket.md | 25 + docs/api/interfaces/BeeOptions.md | 127 + docs/api/interfaces/BeeRequest.md | 41 + docs/api/interfaces/BeeResponse.md | 41 + docs/api/interfaces/BeeVersions.md | 41 + docs/api/interfaces/Bin.md | 41 + docs/api/interfaces/CashoutResult.md | 33 + docs/api/interfaces/ChainState.md | 41 + docs/api/interfaces/Cheque.md | 33 + .../interfaces/ChequebookAddressResponse.md | 17 + .../interfaces/ChequebookBalanceResponse.md | 25 + docs/api/interfaces/CollectionEntry.md | 43 + .../api/interfaces/CollectionUploadOptions.md | 166 + docs/api/interfaces/Data.md | 65 + docs/api/interfaces/DebugStatus.md | 113 + docs/api/interfaces/DownloadOptions.md | 63 + docs/api/interfaces/Envelope.md | 45 + docs/api/interfaces/EnvelopeWithBatchId.md | 69 + docs/api/interfaces/FeedReader.md | 93 + docs/api/interfaces/FeedWriter.md | 205 + docs/api/interfaces/FileData.md | 63 + docs/api/interfaces/FileHeaders.md | 37 + docs/api/interfaces/FileUploadOptions.md | 164 + docs/api/interfaces/GetGranteesResult.md | 33 + docs/api/interfaces/GlobalPostageBatch.md | 73 + docs/api/interfaces/GranteesResult.md | 41 + docs/api/interfaces/GsocMessageHandler.md | 53 + docs/api/interfaces/GsocSubscription.md | 29 + docs/api/interfaces/Health.md | 33 + .../interfaces/LastCashoutActionResponse.md | 49 + .../interfaces/LastChequesForPeerResponse.md | 33 + docs/api/interfaces/LastChequesResponse.md | 17 + docs/api/interfaces/NodeAddresses.md | 49 + docs/api/interfaces/NodeInfo.md | 49 + docs/api/interfaces/Peer.md | 25 + docs/api/interfaces/PeerBalance.md | 25 + docs/api/interfaces/Pin.md | 17 + docs/api/interfaces/PingResponse.md | 17 + docs/api/interfaces/PostageBatch.md | 148 + docs/api/interfaces/PostageBatchBuckets.md | 41 + docs/api/interfaces/PostageBatchOptions.md | 73 + docs/api/interfaces/PssMessageHandler.md | 53 + docs/api/interfaces/PssSubscription.md | 29 + docs/api/interfaces/Readiness.md | 33 + docs/api/interfaces/RedistributionState.md | 129 + docs/api/interfaces/RedundantUploadOptions.md | 136 + docs/api/interfaces/ReferenceInformation.md | 17 + docs/api/interfaces/ReferenceResponse.md | 17 + docs/api/interfaces/RemovePeerResponse.md | 25 + docs/api/interfaces/ReserveState.md | 33 + docs/api/interfaces/SOCReader.md | 45 + docs/api/interfaces/SOCWriter.md | 91 + docs/api/interfaces/Settlements.md | 33 + docs/api/interfaces/Tag.md | 79 + docs/api/interfaces/Topology.md | 209 + docs/api/interfaces/TransactionInfo.md | 81 + docs/api/interfaces/TransactionOptions.md | 29 + docs/api/interfaces/TransactionResponse.md | 17 + docs/api/interfaces/UploadHeaders.md | 49 + docs/api/interfaces/UploadOptions.md | 106 + docs/api/interfaces/UploadResult.md | 41 + docs/api/interfaces/WalletBalance.md | 49 + .../approximateOverheadForRedundancyLevel.md | 34 + .../namespaces/Utils/getAmountForDuration.md | 37 + .../api/namespaces/Utils/getCollectionSize.md | 27 + docs/api/namespaces/Utils/getDepthForSize.md | 25 + docs/api/namespaces/Utils/getFolderSize.md | 27 + .../api/namespaces/Utils/getRedundancyStat.md | 21 + .../namespaces/Utils/getRedundancyStats.md | 31 + docs/api/namespaces/Utils/getStampCost.md | 27 + docs/api/namespaces/Utils/getStampDuration.md | 35 + .../Utils/getStampEffectiveBytes.md | 28 + .../getStampEffectiveBytesBreakpoints.md | 15 + .../Utils/getStampTheoreticalBytes.md | 27 + docs/api/namespaces/Utils/getStampUsage.md | 35 + .../Utils/makeCollectionFromFileList.md | 21 + docs/api/namespaces/Utils/makeMaxTarget.md | 30 + docs/api/type-aliases/BeeRequestOptions.md | 81 + docs/api/type-aliases/Collection.md | 13 + docs/api/type-aliases/HookCallback.md | 27 + docs/api/type-aliases/HttpMethod.md | 11 + docs/api/type-aliases/NumberString.md | 19 + docs/api/variables/BRANCHES.md | 11 + docs/api/variables/CHUNK_SIZE.md | 11 + docs/api/variables/FEED_INDEX_HEX_LENGTH.md | 11 + docs/api/variables/NULL_ADDRESS.md | 11 + docs/api/variables/NULL_IDENTIFIER.md | 11 + docs/api/variables/NULL_OWNER.md | 11 + docs/api/variables/NULL_STAMP.md | 11 + docs/api/variables/NULL_TOPIC.md | 11 + .../variables/PSS_TARGET_HEX_LENGTH_MAX.md | 11 + docs/api/variables/SECTION_SIZE.md | 11 + docs/api/variables/STAMPS_DEPTH_MAX.md | 13 + docs/api/variables/STAMPS_DEPTH_MIN.md | 13 + docs/api/variables/SUPPORTED_BEE_VERSION.md | 11 + .../variables/SUPPORTED_BEE_VERSION_EXACT.md | 11 + docs/api/variables/SWARM_GATEWAY_URL.md | 11 + docs/api/variables/TAGS_LIMIT_MAX.md | 11 + docs/api/variables/TAGS_LIMIT_MIN.md | 11 + sidebars.js | 43 + 132 files changed, 17471 insertions(+) create mode 100644 docs/api/Overview.md create mode 100644 docs/api/classes/BZZ.md create mode 100644 docs/api/classes/BatchId.md create mode 100644 docs/api/classes/Bee.md create mode 100644 docs/api/classes/BeeArgumentError.md create mode 100644 docs/api/classes/BeeDev.md create mode 100644 docs/api/classes/BeeError.md create mode 100644 docs/api/classes/BeeResponseError.md create mode 100644 docs/api/classes/Bytes.md create mode 100644 docs/api/classes/DAI.md create mode 100644 docs/api/classes/Duration.md create mode 100644 docs/api/classes/EthAddress.md create mode 100644 docs/api/classes/FeedIndex.md create mode 100644 docs/api/classes/Identifier.md create mode 100644 docs/api/classes/MantarayNode.md create mode 100644 docs/api/classes/PeerAddress.md create mode 100644 docs/api/classes/PrivateKey.md create mode 100644 docs/api/classes/PublicKey.md create mode 100644 docs/api/classes/Reference.md create mode 100644 docs/api/classes/Signature.md create mode 100644 docs/api/classes/Size.md create mode 100644 docs/api/classes/Span.md create mode 100644 docs/api/classes/Stamper.md create mode 100644 docs/api/classes/Topic.md create mode 100644 docs/api/classes/TransactionId.md create mode 100644 docs/api/enumerations/BeeModes.md create mode 100644 docs/api/enumerations/RedundancyLevel.md create mode 100644 docs/api/enumerations/RedundancyStrategy.md create mode 100644 docs/api/functions/toBeeMode.md create mode 100644 docs/api/interfaces/AllSettlements.md create mode 100644 docs/api/interfaces/AllTagsOptions.md create mode 100644 docs/api/interfaces/BalanceResponse.md create mode 100644 docs/api/interfaces/BatchBucket.md create mode 100644 docs/api/interfaces/BeeOptions.md create mode 100644 docs/api/interfaces/BeeRequest.md create mode 100644 docs/api/interfaces/BeeResponse.md create mode 100644 docs/api/interfaces/BeeVersions.md create mode 100644 docs/api/interfaces/Bin.md create mode 100644 docs/api/interfaces/CashoutResult.md create mode 100644 docs/api/interfaces/ChainState.md create mode 100644 docs/api/interfaces/Cheque.md create mode 100644 docs/api/interfaces/ChequebookAddressResponse.md create mode 100644 docs/api/interfaces/ChequebookBalanceResponse.md create mode 100644 docs/api/interfaces/CollectionEntry.md create mode 100644 docs/api/interfaces/CollectionUploadOptions.md create mode 100644 docs/api/interfaces/Data.md create mode 100644 docs/api/interfaces/DebugStatus.md create mode 100644 docs/api/interfaces/DownloadOptions.md create mode 100644 docs/api/interfaces/Envelope.md create mode 100644 docs/api/interfaces/EnvelopeWithBatchId.md create mode 100644 docs/api/interfaces/FeedReader.md create mode 100644 docs/api/interfaces/FeedWriter.md create mode 100644 docs/api/interfaces/FileData.md create mode 100644 docs/api/interfaces/FileHeaders.md create mode 100644 docs/api/interfaces/FileUploadOptions.md create mode 100644 docs/api/interfaces/GetGranteesResult.md create mode 100644 docs/api/interfaces/GlobalPostageBatch.md create mode 100644 docs/api/interfaces/GranteesResult.md create mode 100644 docs/api/interfaces/GsocMessageHandler.md create mode 100644 docs/api/interfaces/GsocSubscription.md create mode 100644 docs/api/interfaces/Health.md create mode 100644 docs/api/interfaces/LastCashoutActionResponse.md create mode 100644 docs/api/interfaces/LastChequesForPeerResponse.md create mode 100644 docs/api/interfaces/LastChequesResponse.md create mode 100644 docs/api/interfaces/NodeAddresses.md create mode 100644 docs/api/interfaces/NodeInfo.md create mode 100644 docs/api/interfaces/Peer.md create mode 100644 docs/api/interfaces/PeerBalance.md create mode 100644 docs/api/interfaces/Pin.md create mode 100644 docs/api/interfaces/PingResponse.md create mode 100644 docs/api/interfaces/PostageBatch.md create mode 100644 docs/api/interfaces/PostageBatchBuckets.md create mode 100644 docs/api/interfaces/PostageBatchOptions.md create mode 100644 docs/api/interfaces/PssMessageHandler.md create mode 100644 docs/api/interfaces/PssSubscription.md create mode 100644 docs/api/interfaces/Readiness.md create mode 100644 docs/api/interfaces/RedistributionState.md create mode 100644 docs/api/interfaces/RedundantUploadOptions.md create mode 100644 docs/api/interfaces/ReferenceInformation.md create mode 100644 docs/api/interfaces/ReferenceResponse.md create mode 100644 docs/api/interfaces/RemovePeerResponse.md create mode 100644 docs/api/interfaces/ReserveState.md create mode 100644 docs/api/interfaces/SOCReader.md create mode 100644 docs/api/interfaces/SOCWriter.md create mode 100644 docs/api/interfaces/Settlements.md create mode 100644 docs/api/interfaces/Tag.md create mode 100644 docs/api/interfaces/Topology.md create mode 100644 docs/api/interfaces/TransactionInfo.md create mode 100644 docs/api/interfaces/TransactionOptions.md create mode 100644 docs/api/interfaces/TransactionResponse.md create mode 100644 docs/api/interfaces/UploadHeaders.md create mode 100644 docs/api/interfaces/UploadOptions.md create mode 100644 docs/api/interfaces/UploadResult.md create mode 100644 docs/api/interfaces/WalletBalance.md create mode 100644 docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md create mode 100644 docs/api/namespaces/Utils/getAmountForDuration.md create mode 100644 docs/api/namespaces/Utils/getCollectionSize.md create mode 100644 docs/api/namespaces/Utils/getDepthForSize.md create mode 100644 docs/api/namespaces/Utils/getFolderSize.md create mode 100644 docs/api/namespaces/Utils/getRedundancyStat.md create mode 100644 docs/api/namespaces/Utils/getRedundancyStats.md create mode 100644 docs/api/namespaces/Utils/getStampCost.md create mode 100644 docs/api/namespaces/Utils/getStampDuration.md create mode 100644 docs/api/namespaces/Utils/getStampEffectiveBytes.md create mode 100644 docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md create mode 100644 docs/api/namespaces/Utils/getStampTheoreticalBytes.md create mode 100644 docs/api/namespaces/Utils/getStampUsage.md create mode 100644 docs/api/namespaces/Utils/makeCollectionFromFileList.md create mode 100644 docs/api/namespaces/Utils/makeMaxTarget.md create mode 100644 docs/api/type-aliases/BeeRequestOptions.md create mode 100644 docs/api/type-aliases/Collection.md create mode 100644 docs/api/type-aliases/HookCallback.md create mode 100644 docs/api/type-aliases/HttpMethod.md create mode 100644 docs/api/type-aliases/NumberString.md create mode 100644 docs/api/variables/BRANCHES.md create mode 100644 docs/api/variables/CHUNK_SIZE.md create mode 100644 docs/api/variables/FEED_INDEX_HEX_LENGTH.md create mode 100644 docs/api/variables/NULL_ADDRESS.md create mode 100644 docs/api/variables/NULL_IDENTIFIER.md create mode 100644 docs/api/variables/NULL_OWNER.md create mode 100644 docs/api/variables/NULL_STAMP.md create mode 100644 docs/api/variables/NULL_TOPIC.md create mode 100644 docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md create mode 100644 docs/api/variables/SECTION_SIZE.md create mode 100644 docs/api/variables/STAMPS_DEPTH_MAX.md create mode 100644 docs/api/variables/STAMPS_DEPTH_MIN.md create mode 100644 docs/api/variables/SUPPORTED_BEE_VERSION.md create mode 100644 docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md create mode 100644 docs/api/variables/SWARM_GATEWAY_URL.md create mode 100644 docs/api/variables/TAGS_LIMIT_MAX.md create mode 100644 docs/api/variables/TAGS_LIMIT_MIN.md diff --git a/docs/api/Overview.md b/docs/api/Overview.md new file mode 100644 index 00000000..ae7a06dc --- /dev/null +++ b/docs/api/Overview.md @@ -0,0 +1,142 @@ +**@ethersphere/bee-js** + +*** + +# @ethersphere/bee-js + +## Namespaces + +- [Utils](/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel) + +## Enumerations + +- [BeeModes](enumerations/BeeModes.md) +- [RedundancyLevel](enumerations/RedundancyLevel.md) +- [RedundancyStrategy](enumerations/RedundancyStrategy.md) + +## Classes + +- [BatchId](classes/BatchId.md) +- [Bee](classes/Bee.md) +- [BeeArgumentError](classes/BeeArgumentError.md) +- [BeeDev](classes/BeeDev.md) +- [BeeError](classes/BeeError.md) +- [BeeResponseError](classes/BeeResponseError.md) +- [Bytes](classes/Bytes.md) +- [BZZ](classes/BZZ.md) +- [DAI](classes/DAI.md) +- [Duration](classes/Duration.md) +- [EthAddress](classes/EthAddress.md) +- [FeedIndex](classes/FeedIndex.md) +- [Identifier](classes/Identifier.md) +- [MantarayNode](classes/MantarayNode.md) +- [PeerAddress](classes/PeerAddress.md) +- [PrivateKey](classes/PrivateKey.md) +- [PublicKey](classes/PublicKey.md) +- [Reference](classes/Reference.md) +- [Signature](classes/Signature.md) +- [Size](classes/Size.md) +- [Span](classes/Span.md) +- [Stamper](classes/Stamper.md) +- [Topic](classes/Topic.md) +- [TransactionId](classes/TransactionId.md) + +## Interfaces + +- [AllSettlements](interfaces/AllSettlements.md) +- [AllTagsOptions](interfaces/AllTagsOptions.md) +- [BalanceResponse](interfaces/BalanceResponse.md) +- [BatchBucket](interfaces/BatchBucket.md) +- [BeeOptions](interfaces/BeeOptions.md) +- [BeeRequest](interfaces/BeeRequest.md) +- [BeeResponse](interfaces/BeeResponse.md) +- [BeeVersions](interfaces/BeeVersions.md) +- [Bin](interfaces/Bin.md) +- [CashoutResult](interfaces/CashoutResult.md) +- [ChainState](interfaces/ChainState.md) +- [Cheque](interfaces/Cheque.md) +- [ChequebookAddressResponse](interfaces/ChequebookAddressResponse.md) +- [ChequebookBalanceResponse](interfaces/ChequebookBalanceResponse.md) +- [CollectionEntry](interfaces/CollectionEntry.md) +- [CollectionUploadOptions](interfaces/CollectionUploadOptions.md) +- [Data](interfaces/Data.md) +- [DebugStatus](interfaces/DebugStatus.md) +- [DownloadOptions](interfaces/DownloadOptions.md) +- [Envelope](interfaces/Envelope.md) +- [EnvelopeWithBatchId](interfaces/EnvelopeWithBatchId.md) +- [FeedReader](interfaces/FeedReader.md) +- [FeedWriter](interfaces/FeedWriter.md) +- [FileData](interfaces/FileData.md) +- [FileHeaders](interfaces/FileHeaders.md) +- [FileUploadOptions](interfaces/FileUploadOptions.md) +- [GetGranteesResult](interfaces/GetGranteesResult.md) +- [GlobalPostageBatch](interfaces/GlobalPostageBatch.md) +- [GranteesResult](interfaces/GranteesResult.md) +- [GsocMessageHandler](interfaces/GsocMessageHandler.md) +- [GsocSubscription](interfaces/GsocSubscription.md) +- [Health](interfaces/Health.md) +- [LastCashoutActionResponse](interfaces/LastCashoutActionResponse.md) +- [LastChequesForPeerResponse](interfaces/LastChequesForPeerResponse.md) +- [LastChequesResponse](interfaces/LastChequesResponse.md) +- [NodeAddresses](interfaces/NodeAddresses.md) +- [NodeInfo](interfaces/NodeInfo.md) +- [Peer](interfaces/Peer.md) +- [PeerBalance](interfaces/PeerBalance.md) +- [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) +- [Readiness](interfaces/Readiness.md) +- [RedistributionState](interfaces/RedistributionState.md) +- [RedundantUploadOptions](interfaces/RedundantUploadOptions.md) +- [ReferenceInformation](interfaces/ReferenceInformation.md) +- [ReferenceResponse](interfaces/ReferenceResponse.md) +- [RemovePeerResponse](interfaces/RemovePeerResponse.md) +- [ReserveState](interfaces/ReserveState.md) +- [Settlements](interfaces/Settlements.md) +- [SOCReader](interfaces/SOCReader.md) +- [SOCWriter](interfaces/SOCWriter.md) +- [Tag](interfaces/Tag.md) +- [Topology](interfaces/Topology.md) +- [TransactionInfo](interfaces/TransactionInfo.md) +- [TransactionOptions](interfaces/TransactionOptions.md) +- [TransactionResponse](interfaces/TransactionResponse.md) +- [UploadHeaders](interfaces/UploadHeaders.md) +- [UploadOptions](interfaces/UploadOptions.md) +- [UploadResult](interfaces/UploadResult.md) +- [WalletBalance](interfaces/WalletBalance.md) + +## Type Aliases + +- [BeeRequestOptions](type-aliases/BeeRequestOptions.md) +- [Collection](type-aliases/Collection.md) +- [HookCallback](type-aliases/HookCallback.md) +- [HttpMethod](type-aliases/HttpMethod.md) +- [NumberString](type-aliases/NumberString.md) + +## Variables + +- [BRANCHES](variables/BRANCHES.md) +- [CHUNK\_SIZE](variables/CHUNK_SIZE.md) +- [FEED\_INDEX\_HEX\_LENGTH](variables/FEED_INDEX_HEX_LENGTH.md) +- [NULL\_ADDRESS](variables/NULL_ADDRESS.md) +- [NULL\_IDENTIFIER](variables/NULL_IDENTIFIER.md) +- [NULL\_OWNER](variables/NULL_OWNER.md) +- [NULL\_STAMP](variables/NULL_STAMP.md) +- [NULL\_TOPIC](variables/NULL_TOPIC.md) +- [PSS\_TARGET\_HEX\_LENGTH\_MAX](variables/PSS_TARGET_HEX_LENGTH_MAX.md) +- [SECTION\_SIZE](variables/SECTION_SIZE.md) +- [STAMPS\_DEPTH\_MAX](variables/STAMPS_DEPTH_MAX.md) +- [STAMPS\_DEPTH\_MIN](variables/STAMPS_DEPTH_MIN.md) +- [SUPPORTED\_BEE\_VERSION](variables/SUPPORTED_BEE_VERSION.md) +- [SUPPORTED\_BEE\_VERSION\_EXACT](variables/SUPPORTED_BEE_VERSION_EXACT.md) +- [SWARM\_GATEWAY\_URL](variables/SWARM_GATEWAY_URL.md) +- [TAGS\_LIMIT\_MAX](variables/TAGS_LIMIT_MAX.md) +- [TAGS\_LIMIT\_MIN](variables/TAGS_LIMIT_MIN.md) + +## Functions + +- [toBeeMode](functions/toBeeMode.md) diff --git a/docs/api/classes/BZZ.md b/docs/api/classes/BZZ.md new file mode 100644 index 00000000..466ed6d9 --- /dev/null +++ b/docs/api/classes/BZZ.md @@ -0,0 +1,287 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BZZ + +# Class: BZZ + +Defined in: [bee-js/src/utils/tokens.ts:4](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L4) + +## Properties + +### DIGITS + +> `readonly` `static` **DIGITS**: `16` = `16` + +Defined in: [bee-js/src/utils/tokens.ts:5](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L5) + +## Methods + +### divide() + +> **divide**(`other`): `BZZ` + +Defined in: [bee-js/src/utils/tokens.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L63) + +Does not mutate the current BZZ instance. + +#### Parameters + +##### other + +`bigint` + +Divisor + +#### Returns + +`BZZ` + +New BZZ instance + +*** + +### eq() + +> **eq**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L83) + +#### Parameters + +##### other + +`BZZ` + +#### Returns + +`boolean` + +*** + +### exchangeToDAI() + +> **exchangeToDAI**(`daiPerBzz`): [`DAI`](DAI.md) + +Defined in: [bee-js/src/utils/tokens.ts:87](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L87) + +#### Parameters + +##### daiPerBzz + +[`DAI`](DAI.md) + +#### Returns + +[`DAI`](DAI.md) + +*** + +### gt() + +> **gt**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L67) + +#### Parameters + +##### other + +`BZZ` + +#### Returns + +`boolean` + +*** + +### gte() + +> **gte**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L71) + +#### Parameters + +##### other + +`BZZ` + +#### Returns + +`boolean` + +*** + +### lt() + +> **lt**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L75) + +#### Parameters + +##### other + +`BZZ` + +#### Returns + +`boolean` + +*** + +### lte() + +> **lte**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L79) + +#### Parameters + +##### other + +`BZZ` + +#### Returns + +`boolean` + +*** + +### minus() + +> **minus**(`other`): `BZZ` + +Defined in: [bee-js/src/utils/tokens.ts:53](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L53) + +Does not mutate the current BZZ instance. + +#### Parameters + +##### other + +BZZ instance, or amount in PLUR + +`string` | `bigint` | `BZZ` | [`NumberString`](../type-aliases/NumberString.md) + +#### Returns + +`BZZ` + +New BZZ instance + +*** + +### plus() + +> **plus**(`other`): `BZZ` + +Defined in: [bee-js/src/utils/tokens.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L43) + +Does not mutate the current BZZ instance. + +#### Parameters + +##### other + +BZZ instance, or amount in PLUR + +`string` | `bigint` | `BZZ` | [`NumberString`](../type-aliases/NumberString.md) + +#### Returns + +`BZZ` + +New BZZ instance + +*** + +### toDecimalString() + +> **toDecimalString**(): `string` + +Defined in: [bee-js/src/utils/tokens.ts:29](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L29) + +#### Returns + +`string` + +*** + +### toPLURBigInt() + +> **toPLURBigInt**(): `bigint` + +Defined in: [bee-js/src/utils/tokens.ts:25](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L25) + +#### Returns + +`bigint` + +*** + +### toPLURString() + +> **toPLURString**(): `string` + +Defined in: [bee-js/src/utils/tokens.ts:21](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L21) + +#### Returns + +`string` + +*** + +### toSignificantDigits() + +> **toSignificantDigits**(`digits`): `string` + +Defined in: [bee-js/src/utils/tokens.ts:33](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L33) + +#### Parameters + +##### digits + +`number` + +#### Returns + +`string` + +*** + +### fromDecimalString() + +> `static` **fromDecimalString**(`string`): `BZZ` + +Defined in: [bee-js/src/utils/tokens.ts:13](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L13) + +#### Parameters + +##### string + +`string` + +#### Returns + +`BZZ` + +*** + +### fromPLUR() + +> `static` **fromPLUR**(`plur`): `BZZ` + +Defined in: [bee-js/src/utils/tokens.ts:17](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L17) + +#### Parameters + +##### plur + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +#### Returns + +`BZZ` diff --git a/docs/api/classes/BatchId.md b/docs/api/classes/BatchId.md new file mode 100644 index 00000000..54717924 --- /dev/null +++ b/docs/api/classes/BatchId.md @@ -0,0 +1,297 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BatchId + +# Class: BatchId + +Defined in: [bee-js/src/utils/typed-bytes.ts:147](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L147) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new BatchId**(`bytes`): `BatchId` + +Defined in: [bee-js/src/utils/typed-bytes.ts:149](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L149) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`BatchId` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `32` = `32` + +Defined in: [bee-js/src/utils/typed-bytes.ts:148](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L148) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/Bee.md b/docs/api/classes/Bee.md new file mode 100644 index 00000000..8bfc7eeb --- /dev/null +++ b/docs/api/classes/Bee.md @@ -0,0 +1,3205 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Bee + +# Class: Bee + +Defined in: [bee-js/src/bee.ts:142](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L142) + +The main component that abstracts operations available on the main Bee API. + +Not all methods are always available as it depends in what mode is Bee node launched in. +For example gateway mode and light node mode has only limited set of endpoints enabled. + +## Extended by + +- [`BeeDev`](BeeDev.md) + +## Constructors + +### Constructor + +> **new Bee**(`url`, `options?`): `Bee` + +Defined in: [bee-js/src/bee.ts:168](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L168) + +#### Parameters + +##### url + +`string` + +URL on which is the main API of Bee node exposed + +##### options? + +[`BeeOptions`](../interfaces/BeeOptions.md) + +#### Returns + +`Bee` + +## Properties + +### network + +> `readonly` **network**: `"gnosis"` \| `"sepolia"` + +Defined in: [bee-js/src/bee.ts:156](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L156) + +Network on which the Bee node is running + +*** + +### signer? + +> `readonly` `optional` **signer**: [`PrivateKey`](PrivateKey.md) + +Defined in: [bee-js/src/bee.ts:151](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L151) + +Default Signer object used for signing operations, mainly Feeds. + +*** + +### url + +> `readonly` **url**: `string` + +Defined in: [bee-js/src/bee.ts:146](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L146) + +URL on which is the main API of Bee node exposed + +## Methods + +### buyStorage() + +> **buyStorage**(`size`, `duration`, `options?`, `requestOptions?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1649](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1649) + +#### Parameters + +##### size + +[`Size`](Size.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`PostageBatchOptions`](../interfaces/PostageBatchOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +*** + +### cancelPendingTransaction() + +> **cancelPendingTransaction**(`transactionHash`, `gasPrice?`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1907](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1907) + +Cancel currently pending transaction + +#### Parameters + +##### transactionHash + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`TransactionId`](TransactionId.md) + +##### gasPrice? + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +*** + +### cashoutLastCheque() + +> **cashoutLastCheque**(`address`, `options?`, `requestOptions?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1425](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1425) + +Cashout the last cheque for the peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`TransactionOptions`](../interfaces/TransactionOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +*** + +### checkConnection() + +> **checkConnection**(`options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:1265](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1265) + +Ping the Bee node to see if there is a live Bee node on the given URL. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +If connection was not successful throw error + +*** + +### createEnvelope() + +> **createEnvelope**(`postageBatchId`, `reference`, `options?`): `Promise`\<[`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1241](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1241) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md)\> + +*** + +### createFeedManifest() + +> **createFeedManifest**(`postageBatchId`, `topic`, `owner`, `options?`, `requestOptions?`): `Promise`\<[`Reference`](Reference.md)\> + +Defined in: [bee-js/src/bee.ts:1132](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1132) + +Create feed manifest chunk and return the reference to it. + +Feed manifest chunk allows for a feed to be able to be resolved through `/bzz` endpoint. + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to create the Feed Manifest + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### topic + +Topic in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### owner + +Owner's ethereum address in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Reference`](Reference.md)\> + +#### See + + - [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds) + - [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post) + +*** + +### createGrantees() + +> **createGrantees**(`postageBatchId`, `grantees`, `requestOptions?`): `Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +Defined in: [bee-js/src/bee.ts:345](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L345) + +Create a grantees list from the given array of public keys. + +The grantees list can be obtained with the `getGrantees` method. + +#### Parameters + +##### postageBatchId + +The ID of the postage batch. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### grantees + +An array of public keys representing the grantees. + +`string`[] | `Uint8Array`\<`ArrayBufferLike`\>[] | [`PublicKey`](PublicKey.md)[] + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Optional request options. + +#### Returns + +`Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +A promise that resolves to a `GranteesResult` object. + +*** + +### createPostageBatch() + +> **createPostageBatch**(`amount`, `depth`, `options?`, `requestOptions?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1609](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1609) + +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/develop/access-the-swarm/introduction#keep-your-data-alive). + +**WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY** + +#### Parameters + +##### amount + +Amount that represents the value per chunk, has to be greater or equal zero. + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### 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 + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### 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/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `POST /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post) + +*** + +### createTag() + +> **createTag**(`options?`): `Promise`\<[`Tag`](../interfaces/Tag.md)\> + +Defined in: [bee-js/src/bee.ts:649](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L649) + +Create a new Tag which is meant for tracking progres of syncing data across network. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Tag`](../interfaces/Tag.md)\> + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `POST /tags`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/post) + +*** + +### deleteTag() + +> **deleteTag**(`tagUid`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:701](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L701) + +Delete Tag + +#### Parameters + +##### tagUid + +UID or tag object to be retrieved + +`number` | [`Tag`](../interfaces/Tag.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if tagUid is in not correct format + +#### Throws + +BeeResponse error if something went wrong on the Bee node side while deleting the tag. + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `DELETE /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/delete) + +*** + +### depositStake() + +> **depositStake**(`amount`, `options?`, `requestOptions?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1940](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1940) + +Deposits given amount of BZZ token (in PLUR unit). + +Be aware that staked BZZ tokens can **not** be withdrawn. + +#### Parameters + +##### amount + +Amount of BZZ token (in PLUR unit) to be staked. Minimum is 100_000_000_000_000_000 PLUR (10 BZZ). + +`string` | `bigint` | [`BZZ`](BZZ.md) | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`TransactionOptions`](../interfaces/TransactionOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +*** + +### depositTokens() + +> **depositTokens**(`amount`, `gasPrice?`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1446](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1446) + +Deposit tokens from overlay address into chequebook + +#### Parameters + +##### amount + +Amount of tokens to deposit (must be positive integer) + +`string` | `bigint` | [`BZZ`](BZZ.md) | [`NumberString`](../type-aliases/NumberString.md) + +##### gasPrice? + +Gas Price in WEI for the transaction call + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +string Hash of the transaction + +*** + +### diluteBatch() + +> **diluteBatch**(`postageBatchId`, `depth`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1786](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1786) + +Dilute given Postage Batch with new depth (that has to be bigger then the original depth), which allows +the Postage Batch to be used for more chunks. + +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/develop/access-the-swarm/introduction/#keep-your-data-alive). + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### depth + +`number` + +Amount to be added to the batch + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Request options + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1dilute~1%7Bbatch_id%7D~1%7Bdepth%7D/patch) + +*** + +### downloadChunk() + +> **downloadChunk**(`reference`, `options?`, `requestOptions?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [bee-js/src/bee.ts:321](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L321) + +Download chunk as a byte array + +#### Parameters + +##### reference + +Bee chunk reference in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1{address}/get) + +*** + +### downloadData() + +> **downloadData**(`resource`, `options?`, `requestOptions?`): `Promise`\<[`Bytes`](Bytes.md)\> + +Defined in: [bee-js/src/bee.ts:243](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L243) + +Download data as a byte array + +#### Parameters + +##### resource + +Swarm reference, Swarm CID, or ENS domain + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Bytes`](Bytes.md)\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get) + +*** + +### downloadFile() + +> **downloadFile**(`resource`, `path`, `options?`, `requestOptions?`): `Promise`\<[`FileData`](../interfaces/FileData.md)\<[`Bytes`](Bytes.md)\>\> + +Defined in: [bee-js/src/bee.ts:468](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L468) + +Download single file. + +#### Parameters + +##### resource + +Swarm reference, Swarm CID, or ENS domain + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### path + +`string` = `''` + +If reference points to manifest, then this parameter defines path to the file + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`FileData`](../interfaces/FileData.md)\<[`Bytes`](Bytes.md)\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - Data + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get) + +*** + +### downloadReadableData() + +> **downloadReadableData**(`resource`, `options?`, `requestOptions?`): `Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +Defined in: [bee-js/src/bee.ts:265](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L265) + +Download data as a Readable stream + +#### Parameters + +##### resource + +Swarm reference, Swarm CID, or ENS domain + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get) + +*** + +### downloadReadableFile() + +> **downloadReadableFile**(`reference`, `path`, `options?`, `requestOptions?`): `Promise`\<[`FileData`](../interfaces/FileData.md)\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>\> + +Defined in: [bee-js/src/bee.ts:493](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L493) + +Download single file as a readable stream + +#### Parameters + +##### reference + +Bee file reference in hex string (either 64 or 128 chars long), ENS domain or Swarm CID. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### path + +`string` = `''` + +If reference points to manifest / collections, then this parameter defines path to the file + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`FileData`](../interfaces/FileData.md)\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get) + +*** + +### extendStorageDuration() + +> **extendStorageDuration**(`postageBatchId`, `duration`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1688](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1688) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +*** + +### extendStorageSize() + +> **extendStorageSize**(`postageBatchId`, `size`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1674](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1674) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### size + +[`Size`](Size.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +*** + +### fetchLatestFeedUpdate() + +> **fetchLatestFeedUpdate**(`topic`, `owner`, `requestOptions?`): `Promise`\<`FeedPayloadResult`\> + +Defined in: [bee-js/src/bee.ts:1194](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1194) + +#### Parameters + +##### topic + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### owner + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`FeedPayloadResult`\> + +*** + +### getAllBalances() + +> **getAllBalances**(`options?`): `Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1325](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1325) + +Get the balances with all known peers including prepaid services + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +*** + +### ~~getAllGlobalPostageBatch()~~ + +> **getAllGlobalPostageBatch**(`options?`): `Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1846](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1846) + +Return all globally available postage batches. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +#### Deprecated + +Use `getGlobalPostageBatches` instead + +*** + +### getAllPendingTransactions() + +> **getAllPendingTransactions**(`options?`): `Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)[]\> + +Defined in: [bee-js/src/bee.ts:1870](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1870) + +Return lists of all current pending transactions that the Bee made + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)[]\> + +*** + +### getAllPins() + +> **getAllPins**(`options?`): `Promise`\<[`Reference`](Reference.md)[]\> + +Defined in: [bee-js/src/bee.ts:766](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L766) + +Get list of all locally pinned references + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Reference`](Reference.md)[]\> + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +*** + +### ~~getAllPostageBatch()~~ + +> **getAllPostageBatch**(`options?`): `Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1838](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1838) + +Return all postage batches that has the node available. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get) + +#### Deprecated + +Use `getPostageBatches` instead + +*** + +### getAllSettlements() + +> **getAllSettlements**(`options?`): `Promise`\<[`AllSettlements`](../interfaces/AllSettlements.md)\> + +Defined in: [bee-js/src/bee.ts:1506](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1506) + +Get settlements with all known peers and total amount sent or received + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`AllSettlements`](../interfaces/AllSettlements.md)\> + +*** + +### getAllTags() + +> **getAllTags**(`options?`, `requestOptions?`): `Promise`\<[`Tag`](../interfaces/Tag.md)[]\> + +Defined in: [bee-js/src/bee.ts:665](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L665) + +Fetches all tags. + +The listing is limited by options.limit. So you have to iterate using options.offset to get all tags. + +#### Parameters + +##### options? + +[`AllTagsOptions`](../interfaces/AllTagsOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Tag`](../interfaces/Tag.md)[]\> + +#### Throws + +TypeError if limit or offset are not numbers or undefined + +#### Throws + +BeeArgumentError if limit or offset have invalid options + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `GET /tags`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/get) + +*** + +### getBlocklist() + +> **getBlocklist**(`options?`): `Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +Defined in: [bee-js/src/bee.ts:1291](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1291) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +*** + +### getChainState() + +> **getChainState**(`options?`): `Promise`\<[`ChainState`](../interfaces/ChainState.md)\> + +Defined in: [bee-js/src/bee.ts:1579](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1579) + +Get chain state + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ChainState`](../interfaces/ChainState.md)\> + +*** + +### getChequebookAddress() + +> **getChequebookAddress**(`options?`): `Promise`\<[`ChequebookAddressResponse`](../interfaces/ChequebookAddressResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1371](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1371) + +Get the address of the chequebook contract used. + +**Warning:** The address is returned with 0x prefix unlike all other calls. +https://github.com/ethersphere/bee/issues/1443 + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ChequebookAddressResponse`](../interfaces/ChequebookAddressResponse.md)\> + +*** + +### getChequebookBalance() + +> **getChequebookBalance**(`options?`): `Promise`\<[`ChequebookBalanceResponse`](../interfaces/ChequebookBalanceResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1378](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1378) + +Get the balance of the chequebook + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ChequebookBalanceResponse`](../interfaces/ChequebookBalanceResponse.md)\> + +*** + +### getDurationExtensionCost() + +> **getDurationExtensionCost**(`postageBatchId`, `duration`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1736](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1736) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +*** + +### getExtensionCost() + +> **getExtensionCost**(`postageBatchId`, `size`, `duration`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1700](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1700) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### size + +[`Size`](Size.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +*** + +### getGlobalPostageBatches() + +> **getGlobalPostageBatches**(`options?`): `Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1863](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1863) + +Return all globally available postage batches. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +*** + +### getGrantees() + +> **getGrantees**(`reference`, `requestOptions?`): `Promise`\<[`GetGranteesResult`](../interfaces/GetGranteesResult.md)\> + +Defined in: [bee-js/src/bee.ts:363](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L363) + +Retrieves the grantees for a given reference. + +#### Parameters + +##### reference + +The reference. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Optional request options. + +#### Returns + +`Promise`\<[`GetGranteesResult`](../interfaces/GetGranteesResult.md)\> + +A promise that resolves to a `GetGranteesResult` object. + +*** + +### getHealth() + +> **getHealth**(`options?`): `Promise`\<[`Health`](../interfaces/Health.md)\> + +Defined in: [bee-js/src/bee.ts:1520](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1520) + +Get health of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Health`](../interfaces/Health.md)\> + +*** + +### getLastCashoutAction() + +> **getLastCashoutAction**(`address`, `options?`): `Promise`\<[`LastCashoutActionResponse`](../interfaces/LastCashoutActionResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1408](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1408) + +Get last cashout action for the peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`LastCashoutActionResponse`](../interfaces/LastCashoutActionResponse.md)\> + +*** + +### getLastCheques() + +> **getLastCheques**(`options?`): `Promise`\<[`LastChequesResponse`](../interfaces/LastChequesResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1385](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1385) + +Get last cheques for all peers + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`LastChequesResponse`](../interfaces/LastChequesResponse.md)\> + +*** + +### getLastChequesForPeer() + +> **getLastChequesForPeer**(`address`, `options?`): `Promise`\<[`LastChequesForPeerResponse`](../interfaces/LastChequesForPeerResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1394](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1394) + +Get last cheques for the peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`LastChequesForPeerResponse`](../interfaces/LastChequesForPeerResponse.md)\> + +*** + +### getNodeAddresses() + +> **getNodeAddresses**(`options?`): `Promise`\<[`NodeAddresses`](../interfaces/NodeAddresses.md)\> + +Defined in: [bee-js/src/bee.ts:1287](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1287) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`NodeAddresses`](../interfaces/NodeAddresses.md)\> + +*** + +### getNodeInfo() + +> **getNodeInfo**(`options?`): `Promise`\<[`NodeInfo`](../interfaces/NodeInfo.md)\> + +Defined in: [bee-js/src/bee.ts:1534](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1534) + +Get mode information of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`NodeInfo`](../interfaces/NodeInfo.md)\> + +*** + +### getPastDueConsumptionBalances() + +> **getPastDueConsumptionBalances**(`options?`): `Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1343](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1343) + +Get the past due consumption balances with all known peers + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +*** + +### getPastDueConsumptionPeerBalance() + +> **getPastDueConsumptionPeerBalance**(`address`, `options?`): `Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +Defined in: [bee-js/src/bee.ts:1352](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1352) + +Get the past due consumption balance with a specific peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +*** + +### getPeerBalance() + +> **getPeerBalance**(`address`, `options?`): `Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +Defined in: [bee-js/src/bee.ts:1334](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1334) + +Get the balances with a specific peer including prepaid services + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +*** + +### getPeers() + +> **getPeers**(`options?`): `Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +Defined in: [bee-js/src/bee.ts:1298](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1298) + +Get list of peers for this node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +*** + +### getPendingTransaction() + +> **getPendingTransaction**(`transactionHash`, `options?`): `Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)\> + +Defined in: [bee-js/src/bee.ts:1878](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1878) + +Return transaction information for specific transaction + +#### Parameters + +##### transactionHash + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`TransactionId`](TransactionId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)\> + +*** + +### getPin() + +> **getPin**(`reference`, `options?`): `Promise`\<[`Pin`](../interfaces/Pin.md)\> + +Defined in: [bee-js/src/bee.ts:780](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L780) + +Get pinning status of chunk with given reference + +#### Parameters + +##### reference + +Bee data reference in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Pin`](../interfaces/Pin.md)\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +*** + +### getPostageBatch() + +> **getPostageBatch**(`postageBatchId`, `options?`): `Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)\> + +Defined in: [bee-js/src/bee.ts:1805](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1805) + +Return details for specific postage batch. + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D/get) + +*** + +### getPostageBatchBuckets() + +> **getPostageBatchBuckets**(`postageBatchId`, `options?`): `Promise`\<[`PostageBatchBuckets`](../interfaces/PostageBatchBuckets.md)\> + +Defined in: [bee-js/src/bee.ts:1822](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1822) + +Return detailed information related to buckets for specific postage batch. + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatchBuckets`](../interfaces/PostageBatchBuckets.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps/${id}/buckets`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D~1buckets/get) + +*** + +### getPostageBatches() + +> **getPostageBatches**(`options?`): `Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1856](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1856) + +Return all postage batches that belong to the node. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get) + +*** + +### getReadiness() + +> **getReadiness**(`options?`): `Promise`\<[`Readiness`](../interfaces/Readiness.md)\> + +Defined in: [bee-js/src/bee.ts:1527](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1527) + +Get readiness of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Readiness`](../interfaces/Readiness.md)\> + +*** + +### getRedistributionState() + +> **getRedistributionState**(`options?`): `Promise`\<[`RedistributionState`](../interfaces/RedistributionState.md)\> + +Defined in: [bee-js/src/bee.ts:1960](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1960) + +Get current status of node in redistribution game + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`RedistributionState`](../interfaces/RedistributionState.md)\> + +*** + +### getRequestOptionsForCall() + +> `protected` **getRequestOptionsForCall**(`options?`): [`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Defined in: [bee-js/src/bee.ts:1983](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1983) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +*** + +### getReserveState() + +> **getReserveState**(`options?`): `Promise`\<[`ReserveState`](../interfaces/ReserveState.md)\> + +Defined in: [bee-js/src/bee.ts:1572](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1572) + +Get reserve state + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ReserveState`](../interfaces/ReserveState.md)\> + +*** + +### getSettlements() + +> **getSettlements**(`address`, `options?`): `Promise`\<[`Settlements`](../interfaces/Settlements.md)\> + +Defined in: [bee-js/src/bee.ts:1497](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1497) + +Get amount of sent and received from settlements with a peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Settlements`](../interfaces/Settlements.md)\> + +*** + +### getSizeExtensionCost() + +> **getSizeExtensionCost**(`postageBatchId`, `size`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1717](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1717) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### size + +[`Size`](Size.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +*** + +### getStake() + +> **getStake**(`options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1928](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1928) + +Gets the staked amount of BZZ (in PLUR unit) as number string. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +*** + +### getStatus() + +> **getStatus**(`options?`): `Promise`\<[`DebugStatus`](../interfaces/DebugStatus.md)\> + +Defined in: [bee-js/src/bee.ts:1513](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1513) + +Get status of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`DebugStatus`](../interfaces/DebugStatus.md)\> + +*** + +### getStorageCost() + +> **getStorageCost**(`size`, `duration`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1666](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1666) + +#### Parameters + +##### size + +[`Size`](Size.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +*** + +### getTopology() + +> **getTopology**(`options?`): `Promise`\<[`Topology`](../interfaces/Topology.md)\> + +Defined in: [bee-js/src/bee.ts:1308](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1308) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Topology`](../interfaces/Topology.md)\> + +*** + +### getVersions() + +> **getVersions**(`options?`): `Promise`\<[`BeeVersions`](../interfaces/BeeVersions.md)\> + +Defined in: [bee-js/src/bee.ts:1565](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1565) + +Returns object with all versions specified by the connected Bee node (properties prefixed with `bee*`) +and versions that bee-js supports (properties prefixed with `supported*`). + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BeeVersions`](../interfaces/BeeVersions.md)\> + +*** + +### getWalletBalance() + +> **getWalletBalance**(`options?`): `Promise`\<[`WalletBalance`](../interfaces/WalletBalance.md)\> + +Defined in: [bee-js/src/bee.ts:1588](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1588) + +Get wallet balances for xDai and BZZ of the Bee node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`WalletBalance`](../interfaces/WalletBalance.md)\> + +*** + +### gsocMine() + +> **gsocMine**(`targetOverlay`, `identifier`, `proximity`): [`PrivateKey`](PrivateKey.md) + +Defined in: [bee-js/src/bee.ts:1034](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1034) + +#### Parameters + +##### targetOverlay + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PeerAddress`](PeerAddress.md) + +##### identifier + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](Identifier.md) + +##### proximity + +`number` = `12` + +#### Returns + +[`PrivateKey`](PrivateKey.md) + +*** + +### gsocSend() + +> **gsocSend**(`postageBatchId`, `signer`, `identifier`, `data`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:1054](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1054) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### signer + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### identifier + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](Identifier.md) + +##### data + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +*** + +### gsocSubscribe() + +> **gsocSubscribe**(`address`, `identifier`, `handler`): [`GsocSubscription`](../interfaces/GsocSubscription.md) + +Defined in: [bee-js/src/bee.ts:1072](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1072) + +#### Parameters + +##### address + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### identifier + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](Identifier.md) + +##### handler + +[`GsocMessageHandler`](../interfaces/GsocMessageHandler.md) + +#### Returns + +[`GsocSubscription`](../interfaces/GsocSubscription.md) + +*** + +### hashDirectory() + +> **hashDirectory**(`dir`): `Promise`\<[`Reference`](Reference.md)\> + +Defined in: [bee-js/src/bee.ts:541](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L541) + +#### Parameters + +##### dir + +`string` + +#### Returns + +`Promise`\<[`Reference`](Reference.md)\> + +*** + +### isConnected() + +> **isConnected**(`options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:1275](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1275) + +Ping the Bee node to see if there is a live Bee node on the given URL. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`boolean`\> + +true if successful, false on error + +*** + +### isFeedRetrievable() + +> **isFeedRetrievable**(`owner`, `topic`, `index?`, `options?`, `requestOptions?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:842](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L842) + +Functions that validates if feed is retrievable in the network. + +If no index is passed then it check for "latest" update, which is a weaker guarantee as nobody can be really +sure what is the "latest" update. + +If index is passed then it validates all previous sequence index chunks if they are available as they are required +to correctly resolve the feed upto the given index update. + +#### Parameters + +##### owner + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### topic + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### index? + +[`FeedIndex`](FeedIndex.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### isReferenceRetrievable() + +> **isReferenceRetrievable**(`reference`, `options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:818](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L818) + +Checks if content specified by reference is retrievable from the network. + +#### Parameters + +##### reference + +Bee data reference to be checked in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`boolean`\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + +[Bee API reference - `GET /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/get) + +*** + +### isSupportedApiVersion() + +> **isSupportedApiVersion**(`options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:1555](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1555) + +Connects to a node and checks if its Main API version matches with the one that bee-js supports. + +This should be the main way how to check compatibility for your app and Bee node. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### isSupportedExactVersion() + +> **isSupportedExactVersion**(`options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:1543](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1543) + +Connects to a node and checks if its version matches with the one that bee-js supports. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### makeFeedReader() + +> **makeFeedReader**(`topic`, `owner`, `options?`): [`FeedReader`](../interfaces/FeedReader.md) + +Defined in: [bee-js/src/bee.ts:1159](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1159) + +Make a new feed reader for downloading feed updates. + +#### Parameters + +##### topic + +Topic in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### owner + +Owner's ethereum address in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`FeedReader`](../interfaces/FeedReader.md) + +#### See + +[Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds) + +*** + +### makeFeedWriter() + +> **makeFeedWriter**(`topic`, `signer?`, `options?`): [`FeedWriter`](../interfaces/FeedWriter.md) + +Defined in: [bee-js/src/bee.ts:1179](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1179) + +Make a new feed writer for updating feeds + +#### Parameters + +##### topic + +Topic in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### signer? + +The signer's private key or a Signer instance that can sign data + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`FeedWriter`](../interfaces/FeedWriter.md) + +#### See + +[Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds) + +*** + +### makeSOCReader() + +> **makeSOCReader**(`ownerAddress`, `options?`): [`SOCReader`](../interfaces/SOCReader.md) + +Defined in: [bee-js/src/bee.ts:1212](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1212) + +Returns an object for reading single owner chunks + +#### Parameters + +##### ownerAddress + +The ethereum address of the owner + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`SOCReader`](../interfaces/SOCReader.md) + +#### See + +[Bee docs - Chunk Types](https://docs.ethswarm.org/docs/develop/tools-and-features/chunk-types#single-owner-chunks) + +*** + +### makeSOCWriter() + +> **makeSOCWriter**(`signer?`, `options?`): [`SOCWriter`](../interfaces/SOCWriter.md) + +Defined in: [bee-js/src/bee.ts:1228](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1228) + +Returns an object for reading and writing single owner chunks + +#### Parameters + +##### signer? + +The signer's private key or a Signer instance that can sign data + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`SOCWriter`](../interfaces/SOCWriter.md) + +#### See + +[Bee docs - Chunk Types](https://docs.ethswarm.org/docs/develop/tools-and-features/chunk-types#single-owner-chunks) + +*** + +### patchGrantees() + +> **patchGrantees**(`postageBatchId`, `reference`, `history`, `grantees`, `requestOptions?`): `Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +Defined in: [bee-js/src/bee.ts:382](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L382) + +Updates the grantees of a specific reference and history. + +#### Parameters + +##### postageBatchId + +The ID of the postage batch. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### reference + +The reference. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### history + +The history. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### grantees + +The grantees. + +###### add? + +`string`[] \| `Uint8Array`\<`ArrayBufferLike`\>[] \| [`PublicKey`](PublicKey.md)[] + +###### revoke? + +`string`[] \| `Uint8Array`\<`ArrayBufferLike`\>[] \| [`PublicKey`](PublicKey.md)[] + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Optional request options. + +#### Returns + +`Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +A Promise that resolves to to a `GranteesResult` object. + +*** + +### pin() + +> **pin**(`reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:739](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L739) + +Pin local data with given reference + +#### Parameters + +##### reference + +Data reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if reference is in not correct format + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +*** + +### pingPeer() + +> **pingPeer**(`peer`, `options?`): `Promise`\<[`PingResponse`](../interfaces/PingResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1312](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1312) + +#### Parameters + +##### peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PingResponse`](../interfaces/PingResponse.md)\> + +*** + +### probeData() + +> **probeData**(`reference`, `options?`): `Promise`\<[`ReferenceInformation`](../interfaces/ReferenceInformation.md)\> + +Defined in: [bee-js/src/bee.ts:224](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L224) + +Requests content length for a `/bytes` reference + +#### Parameters + +##### reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ReferenceInformation`](../interfaces/ReferenceInformation.md)\> + +#### See + +[Bee API reference - `HEAD /bytes/`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1%7Breference%7D/head) + +*** + +### pssReceive() + +> **pssReceive**(`topic`, `timeoutMsec`): `Promise`\<[`Bytes`](Bytes.md)\> + +Defined in: [bee-js/src/bee.ts:1005](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1005) + +Receive message with Postal Service for Swarm + +Because sending a PSS message is slow and CPU intensive, +it is not supposed to be used for general messaging but +most likely for setting up an encrypted communication +channel by sending an one-off message. + +This is a helper function to wait for exactly one message to +arrive and then cancel the subscription. Additionally a +timeout can be provided for the message to arrive or else +an error will be thrown. + +**Warning! If connected Bee node is a light node, then he will never receive any message!** +This is because light nodes does not fully participate in the data exchange in Swarm network and hence the message won't arrive to them. + +#### Parameters + +##### topic + +[`Topic`](Topic.md) + +Topic name + +##### timeoutMsec + +`number` = `0` + +Timeout in milliseconds + +#### Returns + +`Promise`\<[`Bytes`](Bytes.md)\> + +Message in byte array + +#### See + + - [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss) + - [Bee API reference - `GET /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1{topic}/get) + +*** + +### pssSend() + +> **pssSend**(`postageBatchId`, `topic`, `target`, `data`, `recipient?`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:904](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L904) + +Send data to recipient or target with Postal Service for Swarm. + +Because sending a PSS message is slow and CPU intensive, +it is not supposed to be used for general messaging but +most likely for setting up an encrypted communication +channel by sending an one-off message. + +**Warning! If the recipient Bee node is a light node, then he will never receive the message!** +This is because light nodes does not fully participate in the data exchange in Swarm network and hence the message won't arrive to them. + +#### Parameters + +##### postageBatchId + +Postage BatchId that will be assigned to sent message + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### topic + +[`Topic`](Topic.md) + +Topic name + +##### target + +`string` + +Target message address prefix. Has a limit on length. Recommend to use `Utils.Pss.makeMaxTarget()` to get the most specific target that Bee node will accept. + +##### data + +Message to be sent + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### recipient? + +Recipient public key + +`string` | [`PublicKey`](PublicKey.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if `data`, `batchId`, `target` or `recipient` are in invalid format + +#### See + + - [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss) + - [Bee API reference - `POST /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1send~1{topic}~1{targets}/post) + +*** + +### pssSubscribe() + +> **pssSubscribe**(`topic`, `handler`): [`PssSubscription`](../interfaces/PssSubscription.md) + +Defined in: [bee-js/src/bee.ts:938](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L938) + +Subscribe to messages for given topic with Postal Service for Swarm + +**Warning! If connected Bee node is a light node, then he will never receive any message!** +This is because light nodes does not fully participate in the data exchange in Swarm network and hence the message won't arrive to them. + +#### Parameters + +##### topic + +[`Topic`](Topic.md) + +Topic name + +##### handler + +[`PssMessageHandler`](../interfaces/PssMessageHandler.md) + +Message handler interface + +#### Returns + +[`PssSubscription`](../interfaces/PssSubscription.md) + +Subscription to a given topic + +#### See + + - [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss) + - [Bee API reference - `GET /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1{topic}/get) + +*** + +### rchash() + +> **rchash**(`depth`, `anchor1`, `anchor2`, `options?`): `Promise`\<`number`\> + +Defined in: [bee-js/src/bee.ts:1255](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1255) + +Get reserve commitment hash duration seconds + +#### Parameters + +##### depth + +`number` + +##### anchor1 + +`string` + +##### anchor2 + +`string` + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`number`\> + +*** + +### rebroadcastPendingTransaction() + +> **rebroadcastPendingTransaction**(`transactionHash`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1893](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1893) + +Rebroadcast already created transaction. +This is mainly needed when your transaction fall off mempool from other reason is not incorporated into block. + +#### Parameters + +##### transactionHash + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`TransactionId`](TransactionId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +*** + +### removePeer() + +> **removePeer**(`peer`, `options?`): `Promise`\<[`RemovePeerResponse`](../interfaces/RemovePeerResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1302](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1302) + +#### Parameters + +##### peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`RemovePeerResponse`](../interfaces/RemovePeerResponse.md)\> + +*** + +### retrieveTag() + +> **retrieveTag**(`tagUid`, `options?`): `Promise`\<[`Tag`](../interfaces/Tag.md)\> + +Defined in: [bee-js/src/bee.ts:684](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L684) + +Retrieve tag information from Bee node + +#### Parameters + +##### tagUid + +UID or tag object to be retrieved + +`number` | [`Tag`](../interfaces/Tag.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Tag`](../interfaces/Tag.md)\> + +#### Throws + +TypeError if tagUid is in not correct format + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/get) + +*** + +### reuploadPinnedData() + +> **reuploadPinnedData**(`postageBatchId`, `reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:797](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L797) + +Instructs the Bee node to reupload a locally pinned data into the network. + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### reference + +Bee data reference to be re-uploaded in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +BeeArgumentError if the reference is not locally pinned + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + +[Bee API reference - `PUT /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/put) + +*** + +### streamDirectory() + +> **streamDirectory**(`postageBatchId`, `dir`, `onUploadProgress?`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:545](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L545) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### dir + +`string` + +##### onUploadProgress? + +(`progress`) => `void` + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +*** + +### streamFiles() + +> **streamFiles**(`postageBatchId`, `files`, `onUploadProgress?`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:564](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L564) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### files + +`File`[] | `FileList` + +##### onUploadProgress? + +(`progress`) => `void` + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +*** + +### topUpBatch() + +> **topUpBatch**(`postageBatchId`, `amount`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1761](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1761) + +Topup a fresh amount of BZZ to given Postage Batch. + +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/develop/access-the-swarm/introduction/#keep-your-data-alive). + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### amount + +Amount to be added to the batch + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Request options + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{batch_id}~1{amount}/patch) + +*** + +### unpin() + +> **unpin**(`reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:754](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L754) + +Unpin local data with given reference + +#### Parameters + +##### reference + +Data reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if reference is in not correct format + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +*** + +### updateTag() + +> **updateTag**(`tagUid`, `reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:722](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L722) + +Update tag's total chunks count. + +This is important if you are uploading individual chunks with a tag. Then upon finishing the final root chunk, +you can use this method to update the total chunks count for the tag. + +#### Parameters + +##### tagUid + +UID or tag object to be retrieved + +`number` | [`Tag`](../interfaces/Tag.md) + +##### reference + +The root reference that contains all the chunks to be counted + +`string` | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if tagUid is in not correct format + +#### Throws + +BeeResponse error if something went wrong on the Bee node side while deleting the tag. + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `PATCH /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/patch) + +*** + +### uploadChunk() + +> **uploadChunk**(`stamp`, `data`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:288](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L288) + +Upload chunk to a Bee node + +#### Parameters + +##### stamp + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) | [`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md) + +##### data + +Raw chunk to be uploaded + +`Uint8Array`\<`ArrayBufferLike`\> | `Chunk` + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +Additional options like tag, encryption, pinning, content-type and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +reference is a content hash of the data + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `POST /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post) + +*** + +### uploadCollection() + +> **uploadCollection**(`postageBatchId`, `collection`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:593](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L593) + +Upload Collection that you can assembly yourself. + +The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment. +This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406 + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### collection + +[`Collection`](../type-aliases/Collection.md) + +##### options? + +[`CollectionUploadOptions`](../interfaces/CollectionUploadOptions.md) + +Collections and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +*** + +### uploadData() + +> **uploadData**(`postageBatchId`, `data`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:203](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L203) + +Upload data to a Bee node + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### data + +Data to be uploaded + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### options? + +[`RedundantUploadOptions`](../interfaces/RedundantUploadOptions.md) + +Additional options like tag, encryption, pinning, content-type and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +reference is a content hash of the data + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `POST /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes/post) + +*** + +### uploadFile() + +> **uploadFile**(`postageBatchId`, `data`, `name?`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:420](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L420) + +Upload single file to a Bee node. + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### data + +Data or file to be uploaded + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | `File` | `Readable` + +##### name? + +`string` + +Optional name of the uploaded file + +##### options? + +[`FileUploadOptions`](../interfaces/FileUploadOptions.md) + +Additional options like tag, encryption, pinning, content-type and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +reference is a content hash of the file + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### uploadFiles() + +> **uploadFiles**(`postageBatchId`, `fileList`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:524](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L524) + +Upload collection of files to a Bee node + +Uses the FileList API from the browser. + +The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment. +This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406 + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### fileList + +list of files to be uploaded + +`File`[] | `FileList` + +##### options? + +[`CollectionUploadOptions`](../interfaces/CollectionUploadOptions.md) + +Additional options like tag, encryption, pinning and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee docs - Upload directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### uploadFilesFromDirectory() + +> **uploadFilesFromDirectory**(`postageBatchId`, `dir`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:625](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L625) + +Upload collection of files. + +Available only in Node.js as it uses the `fs` module. + +The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment. +This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406 + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### dir + +`string` + +the path of the files to be uploaded + +##### options? + +[`CollectionUploadOptions`](../interfaces/CollectionUploadOptions.md) + +Additional options like tag, encryption, pinning and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee docs - Upload directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### withdrawTokens() + +> **withdrawTokens**(`amount`, `gasPrice?`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1470](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1470) + +Withdraw tokens from the chequebook to the overlay address + +#### Parameters + +##### amount + +Amount of tokens to withdraw (must be positive integer) + +`string` | `bigint` | [`BZZ`](BZZ.md) | [`NumberString`](../type-aliases/NumberString.md) + +##### gasPrice? + +Gas Price in WEI for the transaction call + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +string Hash of the transaction diff --git a/docs/api/classes/BeeArgumentError.md b/docs/api/classes/BeeArgumentError.md new file mode 100644 index 00000000..e667e443 --- /dev/null +++ b/docs/api/classes/BeeArgumentError.md @@ -0,0 +1,47 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeArgumentError + +# Class: BeeArgumentError + +Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L7) + +## Extends + +- [`BeeError`](BeeError.md) + +## Constructors + +### Constructor + +> **new BeeArgumentError**(`message`, `value`): `BeeArgumentError` + +Defined in: [bee-js/src/utils/error.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L8) + +#### Parameters + +##### message + +`string` + +##### value + +`unknown` + +#### Returns + +`BeeArgumentError` + +#### Overrides + +[`BeeError`](BeeError.md).[`constructor`](BeeError.md#constructor) + +## Properties + +### value + +> `readonly` **value**: `unknown` + +Defined in: [bee-js/src/utils/error.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L8) diff --git a/docs/api/classes/BeeDev.md b/docs/api/classes/BeeDev.md new file mode 100644 index 00000000..90842dd7 --- /dev/null +++ b/docs/api/classes/BeeDev.md @@ -0,0 +1,3621 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeDev + +# Class: BeeDev + +Defined in: [bee-js/src/bee-dev.ts:6](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee-dev.ts#L6) + +The main component that abstracts operations available on the main Bee API. + +Not all methods are always available as it depends in what mode is Bee node launched in. +For example gateway mode and light node mode has only limited set of endpoints enabled. + +## Extends + +- [`Bee`](Bee.md) + +## Constructors + +### Constructor + +> **new BeeDev**(`url`, `options?`): `BeeDev` + +Defined in: [bee-js/src/bee.ts:168](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L168) + +#### Parameters + +##### url + +`string` + +URL on which is the main API of Bee node exposed + +##### options? + +[`BeeOptions`](../interfaces/BeeOptions.md) + +#### Returns + +`BeeDev` + +#### Inherited from + +[`Bee`](Bee.md).[`constructor`](Bee.md#constructor) + +## Properties + +### network + +> `readonly` **network**: `"gnosis"` \| `"sepolia"` + +Defined in: [bee-js/src/bee.ts:156](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L156) + +Network on which the Bee node is running + +#### Inherited from + +[`Bee`](Bee.md).[`network`](Bee.md#network) + +*** + +### signer? + +> `readonly` `optional` **signer**: [`PrivateKey`](PrivateKey.md) + +Defined in: [bee-js/src/bee.ts:151](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L151) + +Default Signer object used for signing operations, mainly Feeds. + +#### Inherited from + +[`Bee`](Bee.md).[`signer`](Bee.md#signer) + +*** + +### url + +> `readonly` **url**: `string` + +Defined in: [bee-js/src/bee.ts:146](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L146) + +URL on which is the main API of Bee node exposed + +#### Inherited from + +[`Bee`](Bee.md).[`url`](Bee.md#url) + +## Methods + +### buyStorage() + +> **buyStorage**(`size`, `duration`, `options?`, `requestOptions?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1649](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1649) + +#### Parameters + +##### size + +[`Size`](Size.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`PostageBatchOptions`](../interfaces/PostageBatchOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`buyStorage`](Bee.md#buystorage) + +*** + +### cancelPendingTransaction() + +> **cancelPendingTransaction**(`transactionHash`, `gasPrice?`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1907](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1907) + +Cancel currently pending transaction + +#### Parameters + +##### transactionHash + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`TransactionId`](TransactionId.md) + +##### gasPrice? + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`cancelPendingTransaction`](Bee.md#cancelpendingtransaction) + +*** + +### cashoutLastCheque() + +> **cashoutLastCheque**(`address`, `options?`, `requestOptions?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1425](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1425) + +Cashout the last cheque for the peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`TransactionOptions`](../interfaces/TransactionOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`cashoutLastCheque`](Bee.md#cashoutlastcheque) + +*** + +### checkConnection() + +> **checkConnection**(`options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:1265](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1265) + +Ping the Bee node to see if there is a live Bee node on the given URL. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +If connection was not successful throw error + +#### Inherited from + +[`Bee`](Bee.md).[`checkConnection`](Bee.md#checkconnection) + +*** + +### createEnvelope() + +> **createEnvelope**(`postageBatchId`, `reference`, `options?`): `Promise`\<[`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1241](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1241) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`createEnvelope`](Bee.md#createenvelope) + +*** + +### createFeedManifest() + +> **createFeedManifest**(`postageBatchId`, `topic`, `owner`, `options?`, `requestOptions?`): `Promise`\<[`Reference`](Reference.md)\> + +Defined in: [bee-js/src/bee.ts:1132](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1132) + +Create feed manifest chunk and return the reference to it. + +Feed manifest chunk allows for a feed to be able to be resolved through `/bzz` endpoint. + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to create the Feed Manifest + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### topic + +Topic in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### owner + +Owner's ethereum address in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Reference`](Reference.md)\> + +#### See + + - [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds) + - [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post) + +#### Inherited from + +[`Bee`](Bee.md).[`createFeedManifest`](Bee.md#createfeedmanifest) + +*** + +### createGrantees() + +> **createGrantees**(`postageBatchId`, `grantees`, `requestOptions?`): `Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +Defined in: [bee-js/src/bee.ts:345](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L345) + +Create a grantees list from the given array of public keys. + +The grantees list can be obtained with the `getGrantees` method. + +#### Parameters + +##### postageBatchId + +The ID of the postage batch. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### grantees + +An array of public keys representing the grantees. + +`string`[] | `Uint8Array`\<`ArrayBufferLike`\>[] | [`PublicKey`](PublicKey.md)[] + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Optional request options. + +#### Returns + +`Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +A promise that resolves to a `GranteesResult` object. + +#### Inherited from + +[`Bee`](Bee.md).[`createGrantees`](Bee.md#creategrantees) + +*** + +### createPostageBatch() + +> **createPostageBatch**(`amount`, `depth`, `options?`, `requestOptions?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1609](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1609) + +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/develop/access-the-swarm/introduction#keep-your-data-alive). + +**WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY** + +#### Parameters + +##### amount + +Amount that represents the value per chunk, has to be greater or equal zero. + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### 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 + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### 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/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `POST /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post) + +#### Inherited from + +[`Bee`](Bee.md).[`createPostageBatch`](Bee.md#createpostagebatch) + +*** + +### createTag() + +> **createTag**(`options?`): `Promise`\<[`Tag`](../interfaces/Tag.md)\> + +Defined in: [bee-js/src/bee.ts:649](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L649) + +Create a new Tag which is meant for tracking progres of syncing data across network. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Tag`](../interfaces/Tag.md)\> + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `POST /tags`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/post) + +#### Inherited from + +[`Bee`](Bee.md).[`createTag`](Bee.md#createtag) + +*** + +### deleteTag() + +> **deleteTag**(`tagUid`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:701](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L701) + +Delete Tag + +#### Parameters + +##### tagUid + +UID or tag object to be retrieved + +`number` | [`Tag`](../interfaces/Tag.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if tagUid is in not correct format + +#### Throws + +BeeResponse error if something went wrong on the Bee node side while deleting the tag. + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `DELETE /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/delete) + +#### Inherited from + +[`Bee`](Bee.md).[`deleteTag`](Bee.md#deletetag) + +*** + +### depositStake() + +> **depositStake**(`amount`, `options?`, `requestOptions?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1940](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1940) + +Deposits given amount of BZZ token (in PLUR unit). + +Be aware that staked BZZ tokens can **not** be withdrawn. + +#### Parameters + +##### amount + +Amount of BZZ token (in PLUR unit) to be staked. Minimum is 100_000_000_000_000_000 PLUR (10 BZZ). + +`string` | `bigint` | [`BZZ`](BZZ.md) | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`TransactionOptions`](../interfaces/TransactionOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`depositStake`](Bee.md#depositstake) + +*** + +### depositTokens() + +> **depositTokens**(`amount`, `gasPrice?`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1446](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1446) + +Deposit tokens from overlay address into chequebook + +#### Parameters + +##### amount + +Amount of tokens to deposit (must be positive integer) + +`string` | `bigint` | [`BZZ`](BZZ.md) | [`NumberString`](../type-aliases/NumberString.md) + +##### gasPrice? + +Gas Price in WEI for the transaction call + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +string Hash of the transaction + +#### Inherited from + +[`Bee`](Bee.md).[`depositTokens`](Bee.md#deposittokens) + +*** + +### diluteBatch() + +> **diluteBatch**(`postageBatchId`, `depth`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1786](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1786) + +Dilute given Postage Batch with new depth (that has to be bigger then the original depth), which allows +the Postage Batch to be used for more chunks. + +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/develop/access-the-swarm/introduction/#keep-your-data-alive). + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### depth + +`number` + +Amount to be added to the batch + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Request options + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1dilute~1%7Bbatch_id%7D~1%7Bdepth%7D/patch) + +#### Inherited from + +[`Bee`](Bee.md).[`diluteBatch`](Bee.md#dilutebatch) + +*** + +### downloadChunk() + +> **downloadChunk**(`reference`, `options?`, `requestOptions?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [bee-js/src/bee.ts:321](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L321) + +Download chunk as a byte array + +#### Parameters + +##### reference + +Bee chunk reference in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1{address}/get) + +#### Inherited from + +[`Bee`](Bee.md).[`downloadChunk`](Bee.md#downloadchunk) + +*** + +### downloadData() + +> **downloadData**(`resource`, `options?`, `requestOptions?`): `Promise`\<[`Bytes`](Bytes.md)\> + +Defined in: [bee-js/src/bee.ts:243](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L243) + +Download data as a byte array + +#### Parameters + +##### resource + +Swarm reference, Swarm CID, or ENS domain + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Bytes`](Bytes.md)\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get) + +#### Inherited from + +[`Bee`](Bee.md).[`downloadData`](Bee.md#downloaddata) + +*** + +### downloadFile() + +> **downloadFile**(`resource`, `path`, `options?`, `requestOptions?`): `Promise`\<[`FileData`](../interfaces/FileData.md)\<[`Bytes`](Bytes.md)\>\> + +Defined in: [bee-js/src/bee.ts:468](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L468) + +Download single file. + +#### Parameters + +##### resource + +Swarm reference, Swarm CID, or ENS domain + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### path + +`string` = `''` + +If reference points to manifest, then this parameter defines path to the file + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`FileData`](../interfaces/FileData.md)\<[`Bytes`](Bytes.md)\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - Data + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get) + +#### Inherited from + +[`Bee`](Bee.md).[`downloadFile`](Bee.md#downloadfile) + +*** + +### downloadReadableData() + +> **downloadReadableData**(`resource`, `options?`, `requestOptions?`): `Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +Defined in: [bee-js/src/bee.ts:265](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L265) + +Download data as a Readable stream + +#### Parameters + +##### resource + +Swarm reference, Swarm CID, or ENS domain + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get) + +#### Inherited from + +[`Bee`](Bee.md).[`downloadReadableData`](Bee.md#downloadreadabledata) + +*** + +### downloadReadableFile() + +> **downloadReadableFile**(`reference`, `path`, `options?`, `requestOptions?`): `Promise`\<[`FileData`](../interfaces/FileData.md)\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>\> + +Defined in: [bee-js/src/bee.ts:493](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L493) + +Download single file as a readable stream + +#### Parameters + +##### reference + +Bee file reference in hex string (either 64 or 128 chars long), ENS domain or Swarm CID. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### path + +`string` = `''` + +If reference points to manifest / collections, then this parameter defines path to the file + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`FileData`](../interfaces/FileData.md)\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get) + +#### Inherited from + +[`Bee`](Bee.md).[`downloadReadableFile`](Bee.md#downloadreadablefile) + +*** + +### extendStorageDuration() + +> **extendStorageDuration**(`postageBatchId`, `duration`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1688](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1688) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`extendStorageDuration`](Bee.md#extendstorageduration) + +*** + +### extendStorageSize() + +> **extendStorageSize**(`postageBatchId`, `size`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1674](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1674) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### size + +[`Size`](Size.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`extendStorageSize`](Bee.md#extendstoragesize) + +*** + +### fetchLatestFeedUpdate() + +> **fetchLatestFeedUpdate**(`topic`, `owner`, `requestOptions?`): `Promise`\<`FeedPayloadResult`\> + +Defined in: [bee-js/src/bee.ts:1194](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1194) + +#### Parameters + +##### topic + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### owner + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`FeedPayloadResult`\> + +#### Inherited from + +[`Bee`](Bee.md).[`fetchLatestFeedUpdate`](Bee.md#fetchlatestfeedupdate) + +*** + +### getAllBalances() + +> **getAllBalances**(`options?`): `Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1325](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1325) + +Get the balances with all known peers including prepaid services + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getAllBalances`](Bee.md#getallbalances) + +*** + +### ~~getAllGlobalPostageBatch()~~ + +> **getAllGlobalPostageBatch**(`options?`): `Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1846](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1846) + +Return all globally available postage batches. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +#### Deprecated + +Use `getGlobalPostageBatches` instead + +#### Inherited from + +[`Bee`](Bee.md).[`getAllGlobalPostageBatch`](Bee.md#getallglobalpostagebatch) + +*** + +### getAllPendingTransactions() + +> **getAllPendingTransactions**(`options?`): `Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)[]\> + +Defined in: [bee-js/src/bee.ts:1870](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1870) + +Return lists of all current pending transactions that the Bee made + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)[]\> + +#### Inherited from + +[`Bee`](Bee.md).[`getAllPendingTransactions`](Bee.md#getallpendingtransactions) + +*** + +### getAllPins() + +> **getAllPins**(`options?`): `Promise`\<[`Reference`](Reference.md)[]\> + +Defined in: [bee-js/src/bee.ts:766](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L766) + +Get list of all locally pinned references + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Reference`](Reference.md)[]\> + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +#### Inherited from + +[`Bee`](Bee.md).[`getAllPins`](Bee.md#getallpins) + +*** + +### ~~getAllPostageBatch()~~ + +> **getAllPostageBatch**(`options?`): `Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1838](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1838) + +Return all postage batches that has the node available. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get) + +#### Deprecated + +Use `getPostageBatches` instead + +#### Inherited from + +[`Bee`](Bee.md).[`getAllPostageBatch`](Bee.md#getallpostagebatch) + +*** + +### getAllSettlements() + +> **getAllSettlements**(`options?`): `Promise`\<[`AllSettlements`](../interfaces/AllSettlements.md)\> + +Defined in: [bee-js/src/bee.ts:1506](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1506) + +Get settlements with all known peers and total amount sent or received + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`AllSettlements`](../interfaces/AllSettlements.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getAllSettlements`](Bee.md#getallsettlements) + +*** + +### getAllTags() + +> **getAllTags**(`options?`, `requestOptions?`): `Promise`\<[`Tag`](../interfaces/Tag.md)[]\> + +Defined in: [bee-js/src/bee.ts:665](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L665) + +Fetches all tags. + +The listing is limited by options.limit. So you have to iterate using options.offset to get all tags. + +#### Parameters + +##### options? + +[`AllTagsOptions`](../interfaces/AllTagsOptions.md) + +Options that affects the request behavior + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Tag`](../interfaces/Tag.md)[]\> + +#### Throws + +TypeError if limit or offset are not numbers or undefined + +#### Throws + +BeeArgumentError if limit or offset have invalid options + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `GET /tags`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/get) + +#### Inherited from + +[`Bee`](Bee.md).[`getAllTags`](Bee.md#getalltags) + +*** + +### getBlocklist() + +> **getBlocklist**(`options?`): `Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +Defined in: [bee-js/src/bee.ts:1291](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1291) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +#### Inherited from + +[`Bee`](Bee.md).[`getBlocklist`](Bee.md#getblocklist) + +*** + +### getChainState() + +> **getChainState**(`options?`): `Promise`\<[`ChainState`](../interfaces/ChainState.md)\> + +Defined in: [bee-js/src/bee.ts:1579](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1579) + +Get chain state + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ChainState`](../interfaces/ChainState.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getChainState`](Bee.md#getchainstate) + +*** + +### getChequebookAddress() + +> **getChequebookAddress**(`options?`): `Promise`\<[`ChequebookAddressResponse`](../interfaces/ChequebookAddressResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1371](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1371) + +Get the address of the chequebook contract used. + +**Warning:** The address is returned with 0x prefix unlike all other calls. +https://github.com/ethersphere/bee/issues/1443 + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ChequebookAddressResponse`](../interfaces/ChequebookAddressResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getChequebookAddress`](Bee.md#getchequebookaddress) + +*** + +### getChequebookBalance() + +> **getChequebookBalance**(`options?`): `Promise`\<[`ChequebookBalanceResponse`](../interfaces/ChequebookBalanceResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1378](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1378) + +Get the balance of the chequebook + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ChequebookBalanceResponse`](../interfaces/ChequebookBalanceResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getChequebookBalance`](Bee.md#getchequebookbalance) + +*** + +### getDurationExtensionCost() + +> **getDurationExtensionCost**(`postageBatchId`, `duration`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1736](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1736) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getDurationExtensionCost`](Bee.md#getdurationextensioncost) + +*** + +### getExtensionCost() + +> **getExtensionCost**(`postageBatchId`, `size`, `duration`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1700](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1700) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### size + +[`Size`](Size.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getExtensionCost`](Bee.md#getextensioncost) + +*** + +### getGlobalPostageBatches() + +> **getGlobalPostageBatches**(`options?`): `Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1863](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1863) + +Return all globally available postage batches. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`GlobalPostageBatch`](../interfaces/GlobalPostageBatch.md)[]\> + +#### Inherited from + +[`Bee`](Bee.md).[`getGlobalPostageBatches`](Bee.md#getglobalpostagebatches) + +*** + +### getGrantees() + +> **getGrantees**(`reference`, `requestOptions?`): `Promise`\<[`GetGranteesResult`](../interfaces/GetGranteesResult.md)\> + +Defined in: [bee-js/src/bee.ts:363](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L363) + +Retrieves the grantees for a given reference. + +#### Parameters + +##### reference + +The reference. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Optional request options. + +#### Returns + +`Promise`\<[`GetGranteesResult`](../interfaces/GetGranteesResult.md)\> + +A promise that resolves to a `GetGranteesResult` object. + +#### Inherited from + +[`Bee`](Bee.md).[`getGrantees`](Bee.md#getgrantees) + +*** + +### getHealth() + +> **getHealth**(`options?`): `Promise`\<[`Health`](../interfaces/Health.md)\> + +Defined in: [bee-js/src/bee.ts:1520](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1520) + +Get health of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Health`](../interfaces/Health.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getHealth`](Bee.md#gethealth) + +*** + +### getLastCashoutAction() + +> **getLastCashoutAction**(`address`, `options?`): `Promise`\<[`LastCashoutActionResponse`](../interfaces/LastCashoutActionResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1408](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1408) + +Get last cashout action for the peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`LastCashoutActionResponse`](../interfaces/LastCashoutActionResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getLastCashoutAction`](Bee.md#getlastcashoutaction) + +*** + +### getLastCheques() + +> **getLastCheques**(`options?`): `Promise`\<[`LastChequesResponse`](../interfaces/LastChequesResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1385](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1385) + +Get last cheques for all peers + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`LastChequesResponse`](../interfaces/LastChequesResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getLastCheques`](Bee.md#getlastcheques) + +*** + +### getLastChequesForPeer() + +> **getLastChequesForPeer**(`address`, `options?`): `Promise`\<[`LastChequesForPeerResponse`](../interfaces/LastChequesForPeerResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1394](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1394) + +Get last cheques for the peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`LastChequesForPeerResponse`](../interfaces/LastChequesForPeerResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getLastChequesForPeer`](Bee.md#getlastchequesforpeer) + +*** + +### getNodeAddresses() + +> **getNodeAddresses**(`options?`): `Promise`\<[`NodeAddresses`](../interfaces/NodeAddresses.md)\> + +Defined in: [bee-js/src/bee-dev.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee-dev.ts#L7) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`NodeAddresses`](../interfaces/NodeAddresses.md)\> + +#### Overrides + +[`Bee`](Bee.md).[`getNodeAddresses`](Bee.md#getnodeaddresses) + +*** + +### getNodeInfo() + +> **getNodeInfo**(`options?`): `Promise`\<[`NodeInfo`](../interfaces/NodeInfo.md)\> + +Defined in: [bee-js/src/bee.ts:1534](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1534) + +Get mode information of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`NodeInfo`](../interfaces/NodeInfo.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getNodeInfo`](Bee.md#getnodeinfo) + +*** + +### getPastDueConsumptionBalances() + +> **getPastDueConsumptionBalances**(`options?`): `Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1343](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1343) + +Get the past due consumption balances with all known peers + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BalanceResponse`](../interfaces/BalanceResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getPastDueConsumptionBalances`](Bee.md#getpastdueconsumptionbalances) + +*** + +### getPastDueConsumptionPeerBalance() + +> **getPastDueConsumptionPeerBalance**(`address`, `options?`): `Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +Defined in: [bee-js/src/bee.ts:1352](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1352) + +Get the past due consumption balance with a specific peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getPastDueConsumptionPeerBalance`](Bee.md#getpastdueconsumptionpeerbalance) + +*** + +### getPeerBalance() + +> **getPeerBalance**(`address`, `options?`): `Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +Defined in: [bee-js/src/bee.ts:1334](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1334) + +Get the balances with a specific peer including prepaid services + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PeerBalance`](../interfaces/PeerBalance.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getPeerBalance`](Bee.md#getpeerbalance) + +*** + +### getPeers() + +> **getPeers**(`options?`): `Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +Defined in: [bee-js/src/bee.ts:1298](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1298) + +Get list of peers for this node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Peer`](../interfaces/Peer.md)[]\> + +#### Inherited from + +[`Bee`](Bee.md).[`getPeers`](Bee.md#getpeers) + +*** + +### getPendingTransaction() + +> **getPendingTransaction**(`transactionHash`, `options?`): `Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)\> + +Defined in: [bee-js/src/bee.ts:1878](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1878) + +Return transaction information for specific transaction + +#### Parameters + +##### transactionHash + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`TransactionId`](TransactionId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionInfo`](../interfaces/TransactionInfo.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getPendingTransaction`](Bee.md#getpendingtransaction) + +*** + +### getPin() + +> **getPin**(`reference`, `options?`): `Promise`\<[`Pin`](../interfaces/Pin.md)\> + +Defined in: [bee-js/src/bee.ts:780](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L780) + +Get pinning status of chunk with given reference + +#### Parameters + +##### reference + +Bee data reference in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Pin`](../interfaces/Pin.md)\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +#### Inherited from + +[`Bee`](Bee.md).[`getPin`](Bee.md#getpin) + +*** + +### getPostageBatch() + +> **getPostageBatch**(`postageBatchId`, `options?`): `Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)\> + +Defined in: [bee-js/src/bee.ts:1805](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1805) + +Return details for specific postage batch. + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D/get) + +#### Inherited from + +[`Bee`](Bee.md).[`getPostageBatch`](Bee.md#getpostagebatch) + +*** + +### getPostageBatchBuckets() + +> **getPostageBatchBuckets**(`postageBatchId`, `options?`): `Promise`\<[`PostageBatchBuckets`](../interfaces/PostageBatchBuckets.md)\> + +Defined in: [bee-js/src/bee.ts:1822](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1822) + +Return detailed information related to buckets for specific postage batch. + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatchBuckets`](../interfaces/PostageBatchBuckets.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps/${id}/buckets`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D~1buckets/get) + +#### Inherited from + +[`Bee`](Bee.md).[`getPostageBatchBuckets`](Bee.md#getpostagebatchbuckets) + +*** + +### getPostageBatches() + +> **getPostageBatches**(`options?`): `Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +Defined in: [bee-js/src/bee.ts:1856](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1856) + +Return all postage batches that belong to the node. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PostageBatch`](../interfaces/PostageBatch.md)[]\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get) + +#### Inherited from + +[`Bee`](Bee.md).[`getPostageBatches`](Bee.md#getpostagebatches) + +*** + +### getReadiness() + +> **getReadiness**(`options?`): `Promise`\<[`Readiness`](../interfaces/Readiness.md)\> + +Defined in: [bee-js/src/bee.ts:1527](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1527) + +Get readiness of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Readiness`](../interfaces/Readiness.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getReadiness`](Bee.md#getreadiness) + +*** + +### getRedistributionState() + +> **getRedistributionState**(`options?`): `Promise`\<[`RedistributionState`](../interfaces/RedistributionState.md)\> + +Defined in: [bee-js/src/bee.ts:1960](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1960) + +Get current status of node in redistribution game + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`RedistributionState`](../interfaces/RedistributionState.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getRedistributionState`](Bee.md#getredistributionstate) + +*** + +### getRequestOptionsForCall() + +> `protected` **getRequestOptionsForCall**(`options?`): [`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Defined in: [bee-js/src/bee.ts:1983](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1983) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Inherited from + +[`Bee`](Bee.md).[`getRequestOptionsForCall`](Bee.md#getrequestoptionsforcall) + +*** + +### getReserveState() + +> **getReserveState**(`options?`): `Promise`\<[`ReserveState`](../interfaces/ReserveState.md)\> + +Defined in: [bee-js/src/bee.ts:1572](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1572) + +Get reserve state + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ReserveState`](../interfaces/ReserveState.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getReserveState`](Bee.md#getreservestate) + +*** + +### getSettlements() + +> **getSettlements**(`address`, `options?`): `Promise`\<[`Settlements`](../interfaces/Settlements.md)\> + +Defined in: [bee-js/src/bee.ts:1497](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1497) + +Get amount of sent and received from settlements with a peer + +#### Parameters + +##### address + +Swarm address of peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Settlements`](../interfaces/Settlements.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getSettlements`](Bee.md#getsettlements) + +*** + +### getSizeExtensionCost() + +> **getSizeExtensionCost**(`postageBatchId`, `size`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1717](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1717) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### size + +[`Size`](Size.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getSizeExtensionCost`](Bee.md#getsizeextensioncost) + +*** + +### getStake() + +> **getStake**(`options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1928](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1928) + +Gets the staked amount of BZZ (in PLUR unit) as number string. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getStake`](Bee.md#getstake) + +*** + +### getStatus() + +> **getStatus**(`options?`): `Promise`\<[`DebugStatus`](../interfaces/DebugStatus.md)\> + +Defined in: [bee-js/src/bee.ts:1513](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1513) + +Get status of node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`DebugStatus`](../interfaces/DebugStatus.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getStatus`](Bee.md#getstatus) + +*** + +### getStorageCost() + +> **getStorageCost**(`size`, `duration`, `options?`): `Promise`\<[`BZZ`](BZZ.md)\> + +Defined in: [bee-js/src/bee.ts:1666](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1666) + +#### Parameters + +##### size + +[`Size`](Size.md) + +##### duration + +[`Duration`](Duration.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BZZ`](BZZ.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getStorageCost`](Bee.md#getstoragecost) + +*** + +### getTopology() + +> **getTopology**(`options?`): `Promise`\<[`Topology`](../interfaces/Topology.md)\> + +Defined in: [bee-js/src/bee-dev.ts:26](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee-dev.ts#L26) + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`Topology`](../interfaces/Topology.md)\> + +#### Overrides + +[`Bee`](Bee.md).[`getTopology`](Bee.md#gettopology) + +*** + +### getVersions() + +> **getVersions**(`options?`): `Promise`\<[`BeeVersions`](../interfaces/BeeVersions.md)\> + +Defined in: [bee-js/src/bee.ts:1565](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1565) + +Returns object with all versions specified by the connected Bee node (properties prefixed with `bee*`) +and versions that bee-js supports (properties prefixed with `supported*`). + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`BeeVersions`](../interfaces/BeeVersions.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getVersions`](Bee.md#getversions) + +*** + +### getWalletBalance() + +> **getWalletBalance**(`options?`): `Promise`\<[`WalletBalance`](../interfaces/WalletBalance.md)\> + +Defined in: [bee-js/src/bee.ts:1588](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1588) + +Get wallet balances for xDai and BZZ of the Bee node + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`WalletBalance`](../interfaces/WalletBalance.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`getWalletBalance`](Bee.md#getwalletbalance) + +*** + +### gsocMine() + +> **gsocMine**(`targetOverlay`, `identifier`, `proximity`): [`PrivateKey`](PrivateKey.md) + +Defined in: [bee-js/src/bee.ts:1034](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1034) + +#### Parameters + +##### targetOverlay + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PeerAddress`](PeerAddress.md) + +##### identifier + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](Identifier.md) + +##### proximity + +`number` = `12` + +#### Returns + +[`PrivateKey`](PrivateKey.md) + +#### Inherited from + +[`Bee`](Bee.md).[`gsocMine`](Bee.md#gsocmine) + +*** + +### gsocSend() + +> **gsocSend**(`postageBatchId`, `signer`, `identifier`, `data`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:1054](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1054) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### signer + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### identifier + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](Identifier.md) + +##### data + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`gsocSend`](Bee.md#gsocsend) + +*** + +### gsocSubscribe() + +> **gsocSubscribe**(`address`, `identifier`, `handler`): [`GsocSubscription`](../interfaces/GsocSubscription.md) + +Defined in: [bee-js/src/bee.ts:1072](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1072) + +#### Parameters + +##### address + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### identifier + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](Identifier.md) + +##### handler + +[`GsocMessageHandler`](../interfaces/GsocMessageHandler.md) + +#### Returns + +[`GsocSubscription`](../interfaces/GsocSubscription.md) + +#### Inherited from + +[`Bee`](Bee.md).[`gsocSubscribe`](Bee.md#gsocsubscribe) + +*** + +### hashDirectory() + +> **hashDirectory**(`dir`): `Promise`\<[`Reference`](Reference.md)\> + +Defined in: [bee-js/src/bee.ts:541](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L541) + +#### Parameters + +##### dir + +`string` + +#### Returns + +`Promise`\<[`Reference`](Reference.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`hashDirectory`](Bee.md#hashdirectory) + +*** + +### isConnected() + +> **isConnected**(`options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:1275](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1275) + +Ping the Bee node to see if there is a live Bee node on the given URL. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`boolean`\> + +true if successful, false on error + +#### Inherited from + +[`Bee`](Bee.md).[`isConnected`](Bee.md#isconnected) + +*** + +### isFeedRetrievable() + +> **isFeedRetrievable**(`owner`, `topic`, `index?`, `options?`, `requestOptions?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:842](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L842) + +Functions that validates if feed is retrievable in the network. + +If no index is passed then it check for "latest" update, which is a weaker guarantee as nobody can be really +sure what is the "latest" update. + +If index is passed then it validates all previous sequence index chunks if they are available as they are required +to correctly resolve the feed upto the given index update. + +#### Parameters + +##### owner + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### topic + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### index? + +[`FeedIndex`](FeedIndex.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`boolean`\> + +#### Inherited from + +[`Bee`](Bee.md).[`isFeedRetrievable`](Bee.md#isfeedretrievable) + +*** + +### isReferenceRetrievable() + +> **isReferenceRetrievable**(`reference`, `options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:818](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L818) + +Checks if content specified by reference is retrievable from the network. + +#### Parameters + +##### reference + +Bee data reference to be checked in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`boolean`\> + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + +[Bee API reference - `GET /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/get) + +#### Inherited from + +[`Bee`](Bee.md).[`isReferenceRetrievable`](Bee.md#isreferenceretrievable) + +*** + +### isSupportedApiVersion() + +> **isSupportedApiVersion**(`options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:1555](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1555) + +Connects to a node and checks if its Main API version matches with the one that bee-js supports. + +This should be the main way how to check compatibility for your app and Bee node. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`boolean`\> + +#### Inherited from + +[`Bee`](Bee.md).[`isSupportedApiVersion`](Bee.md#issupportedapiversion) + +*** + +### isSupportedExactVersion() + +> **isSupportedExactVersion**(`options?`): `Promise`\<`boolean`\> + +Defined in: [bee-js/src/bee.ts:1543](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1543) + +Connects to a node and checks if its version matches with the one that bee-js supports. + +#### Parameters + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`boolean`\> + +#### Inherited from + +[`Bee`](Bee.md).[`isSupportedExactVersion`](Bee.md#issupportedexactversion) + +*** + +### makeFeedReader() + +> **makeFeedReader**(`topic`, `owner`, `options?`): [`FeedReader`](../interfaces/FeedReader.md) + +Defined in: [bee-js/src/bee.ts:1159](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1159) + +Make a new feed reader for downloading feed updates. + +#### Parameters + +##### topic + +Topic in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### owner + +Owner's ethereum address in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`FeedReader`](../interfaces/FeedReader.md) + +#### See + +[Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds) + +#### Inherited from + +[`Bee`](Bee.md).[`makeFeedReader`](Bee.md#makefeedreader) + +*** + +### makeFeedWriter() + +> **makeFeedWriter**(`topic`, `signer?`, `options?`): [`FeedWriter`](../interfaces/FeedWriter.md) + +Defined in: [bee-js/src/bee.ts:1179](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1179) + +Make a new feed writer for updating feeds + +#### Parameters + +##### topic + +Topic in hex or bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Topic`](Topic.md) + +##### signer? + +The signer's private key or a Signer instance that can sign data + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`FeedWriter`](../interfaces/FeedWriter.md) + +#### See + +[Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds) + +#### Inherited from + +[`Bee`](Bee.md).[`makeFeedWriter`](Bee.md#makefeedwriter) + +*** + +### makeSOCReader() + +> **makeSOCReader**(`ownerAddress`, `options?`): [`SOCReader`](../interfaces/SOCReader.md) + +Defined in: [bee-js/src/bee.ts:1212](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1212) + +Returns an object for reading single owner chunks + +#### Parameters + +##### ownerAddress + +The ethereum address of the owner + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`SOCReader`](../interfaces/SOCReader.md) + +#### See + +[Bee docs - Chunk Types](https://docs.ethswarm.org/docs/develop/tools-and-features/chunk-types#single-owner-chunks) + +#### Inherited from + +[`Bee`](Bee.md).[`makeSOCReader`](Bee.md#makesocreader) + +*** + +### makeSOCWriter() + +> **makeSOCWriter**(`signer?`, `options?`): [`SOCWriter`](../interfaces/SOCWriter.md) + +Defined in: [bee-js/src/bee.ts:1228](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1228) + +Returns an object for reading and writing single owner chunks + +#### Parameters + +##### signer? + +The signer's private key or a Signer instance that can sign data + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +[`SOCWriter`](../interfaces/SOCWriter.md) + +#### See + +[Bee docs - Chunk Types](https://docs.ethswarm.org/docs/develop/tools-and-features/chunk-types#single-owner-chunks) + +#### Inherited from + +[`Bee`](Bee.md).[`makeSOCWriter`](Bee.md#makesocwriter) + +*** + +### patchGrantees() + +> **patchGrantees**(`postageBatchId`, `reference`, `history`, `grantees`, `requestOptions?`): `Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +Defined in: [bee-js/src/bee.ts:382](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L382) + +Updates the grantees of a specific reference and history. + +#### Parameters + +##### postageBatchId + +The ID of the postage batch. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### reference + +The reference. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### history + +The history. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### grantees + +The grantees. + +###### add? + +`string`[] \| `Uint8Array`\<`ArrayBufferLike`\>[] \| [`PublicKey`](PublicKey.md)[] + +###### revoke? + +`string`[] \| `Uint8Array`\<`ArrayBufferLike`\>[] \| [`PublicKey`](PublicKey.md)[] + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Optional request options. + +#### Returns + +`Promise`\<[`GranteesResult`](../interfaces/GranteesResult.md)\> + +A Promise that resolves to to a `GranteesResult` object. + +#### Inherited from + +[`Bee`](Bee.md).[`patchGrantees`](Bee.md#patchgrantees) + +*** + +### pin() + +> **pin**(`reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:739](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L739) + +Pin local data with given reference + +#### Parameters + +##### reference + +Data reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if reference is in not correct format + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +#### Inherited from + +[`Bee`](Bee.md).[`pin`](Bee.md#pin) + +*** + +### pingPeer() + +> **pingPeer**(`peer`, `options?`): `Promise`\<[`PingResponse`](../interfaces/PingResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1312](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1312) + +#### Parameters + +##### peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`PingResponse`](../interfaces/PingResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`pingPeer`](Bee.md#pingpeer) + +*** + +### probeData() + +> **probeData**(`reference`, `options?`): `Promise`\<[`ReferenceInformation`](../interfaces/ReferenceInformation.md)\> + +Defined in: [bee-js/src/bee.ts:224](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L224) + +Requests content length for a `/bytes` reference + +#### Parameters + +##### reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`ReferenceInformation`](../interfaces/ReferenceInformation.md)\> + +#### See + +[Bee API reference - `HEAD /bytes/`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1%7Breference%7D/head) + +#### Inherited from + +[`Bee`](Bee.md).[`probeData`](Bee.md#probedata) + +*** + +### pssReceive() + +> **pssReceive**(`topic`, `timeoutMsec`): `Promise`\<[`Bytes`](Bytes.md)\> + +Defined in: [bee-js/src/bee.ts:1005](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1005) + +Receive message with Postal Service for Swarm + +Because sending a PSS message is slow and CPU intensive, +it is not supposed to be used for general messaging but +most likely for setting up an encrypted communication +channel by sending an one-off message. + +This is a helper function to wait for exactly one message to +arrive and then cancel the subscription. Additionally a +timeout can be provided for the message to arrive or else +an error will be thrown. + +**Warning! If connected Bee node is a light node, then he will never receive any message!** +This is because light nodes does not fully participate in the data exchange in Swarm network and hence the message won't arrive to them. + +#### Parameters + +##### topic + +[`Topic`](Topic.md) + +Topic name + +##### timeoutMsec + +`number` = `0` + +Timeout in milliseconds + +#### Returns + +`Promise`\<[`Bytes`](Bytes.md)\> + +Message in byte array + +#### See + + - [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss) + - [Bee API reference - `GET /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1{topic}/get) + +#### Inherited from + +[`Bee`](Bee.md).[`pssReceive`](Bee.md#pssreceive) + +*** + +### pssSend() + +> **pssSend**(`postageBatchId`, `topic`, `target`, `data`, `recipient?`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:904](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L904) + +Send data to recipient or target with Postal Service for Swarm. + +Because sending a PSS message is slow and CPU intensive, +it is not supposed to be used for general messaging but +most likely for setting up an encrypted communication +channel by sending an one-off message. + +**Warning! If the recipient Bee node is a light node, then he will never receive the message!** +This is because light nodes does not fully participate in the data exchange in Swarm network and hence the message won't arrive to them. + +#### Parameters + +##### postageBatchId + +Postage BatchId that will be assigned to sent message + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### topic + +[`Topic`](Topic.md) + +Topic name + +##### target + +`string` + +Target message address prefix. Has a limit on length. Recommend to use `Utils.Pss.makeMaxTarget()` to get the most specific target that Bee node will accept. + +##### data + +Message to be sent + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### recipient? + +Recipient public key + +`string` | [`PublicKey`](PublicKey.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if `data`, `batchId`, `target` or `recipient` are in invalid format + +#### See + + - [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss) + - [Bee API reference - `POST /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1send~1{topic}~1{targets}/post) + +#### Inherited from + +[`Bee`](Bee.md).[`pssSend`](Bee.md#psssend) + +*** + +### pssSubscribe() + +> **pssSubscribe**(`topic`, `handler`): [`PssSubscription`](../interfaces/PssSubscription.md) + +Defined in: [bee-js/src/bee.ts:938](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L938) + +Subscribe to messages for given topic with Postal Service for Swarm + +**Warning! If connected Bee node is a light node, then he will never receive any message!** +This is because light nodes does not fully participate in the data exchange in Swarm network and hence the message won't arrive to them. + +#### Parameters + +##### topic + +[`Topic`](Topic.md) + +Topic name + +##### handler + +[`PssMessageHandler`](../interfaces/PssMessageHandler.md) + +Message handler interface + +#### Returns + +[`PssSubscription`](../interfaces/PssSubscription.md) + +Subscription to a given topic + +#### See + + - [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss) + - [Bee API reference - `GET /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1{topic}/get) + +#### Inherited from + +[`Bee`](Bee.md).[`pssSubscribe`](Bee.md#psssubscribe) + +*** + +### rchash() + +> **rchash**(`depth`, `anchor1`, `anchor2`, `options?`): `Promise`\<`number`\> + +Defined in: [bee-js/src/bee.ts:1255](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1255) + +Get reserve commitment hash duration seconds + +#### Parameters + +##### depth + +`number` + +##### anchor1 + +`string` + +##### anchor2 + +`string` + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +[`Bee`](Bee.md).[`rchash`](Bee.md#rchash) + +*** + +### rebroadcastPendingTransaction() + +> **rebroadcastPendingTransaction**(`transactionHash`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1893](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1893) + +Rebroadcast already created transaction. +This is mainly needed when your transaction fall off mempool from other reason is not incorporated into block. + +#### Parameters + +##### transactionHash + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`TransactionId`](TransactionId.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`rebroadcastPendingTransaction`](Bee.md#rebroadcastpendingtransaction) + +*** + +### removePeer() + +> **removePeer**(`peer`, `options?`): `Promise`\<[`RemovePeerResponse`](../interfaces/RemovePeerResponse.md)\> + +Defined in: [bee-js/src/bee.ts:1302](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1302) + +#### Parameters + +##### peer + +`string` | [`PeerAddress`](PeerAddress.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`RemovePeerResponse`](../interfaces/RemovePeerResponse.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`removePeer`](Bee.md#removepeer) + +*** + +### retrieveTag() + +> **retrieveTag**(`tagUid`, `options?`): `Promise`\<[`Tag`](../interfaces/Tag.md)\> + +Defined in: [bee-js/src/bee.ts:684](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L684) + +Retrieve tag information from Bee node + +#### Parameters + +##### tagUid + +UID or tag object to be retrieved + +`number` | [`Tag`](../interfaces/Tag.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<[`Tag`](../interfaces/Tag.md)\> + +#### Throws + +TypeError if tagUid is in not correct format + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/get) + +#### Inherited from + +[`Bee`](Bee.md).[`retrieveTag`](Bee.md#retrievetag) + +*** + +### reuploadPinnedData() + +> **reuploadPinnedData**(`postageBatchId`, `reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:797](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L797) + +Instructs the Bee node to reupload a locally pinned data into the network. + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### reference + +Bee data reference to be re-uploaded in hex string (either 64 or 128 chars long) or ENS domain. + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +BeeArgumentError if the reference is not locally pinned + +#### Throws + +TypeError if some of the input parameters is not expected type + +#### Throws + +BeeArgumentError if there is passed ENS domain with invalid unicode characters + +#### See + +[Bee API reference - `PUT /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/put) + +#### Inherited from + +[`Bee`](Bee.md).[`reuploadPinnedData`](Bee.md#reuploadpinneddata) + +*** + +### streamDirectory() + +> **streamDirectory**(`postageBatchId`, `dir`, `onUploadProgress?`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:545](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L545) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### dir + +`string` + +##### onUploadProgress? + +(`progress`) => `void` + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`streamDirectory`](Bee.md#streamdirectory) + +*** + +### streamFiles() + +> **streamFiles**(`postageBatchId`, `files`, `onUploadProgress?`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:564](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L564) + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### files + +`File`[] | `FileList` + +##### onUploadProgress? + +(`progress`) => `void` + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`streamFiles`](Bee.md#streamfiles) + +*** + +### topUpBatch() + +> **topUpBatch**(`postageBatchId`, `amount`, `options?`): `Promise`\<[`BatchId`](BatchId.md)\> + +Defined in: [bee-js/src/bee.ts:1761](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1761) + +Topup a fresh amount of BZZ to given Postage Batch. + +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/develop/access-the-swarm/introduction/#keep-your-data-alive). + +#### Parameters + +##### postageBatchId + +Batch ID + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### amount + +Amount to be added to the batch + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Request options + +#### Returns + +`Promise`\<[`BatchId`](BatchId.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{batch_id}~1{amount}/patch) + +#### Inherited from + +[`Bee`](Bee.md).[`topUpBatch`](Bee.md#topupbatch) + +*** + +### unpin() + +> **unpin**(`reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:754](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L754) + +Unpin local data with given reference + +#### Parameters + +##### reference + +Data reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if reference is in not correct format + +#### See + +[Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + +#### Inherited from + +[`Bee`](Bee.md).[`unpin`](Bee.md#unpin) + +*** + +### updateTag() + +> **updateTag**(`tagUid`, `reference`, `options?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/bee.ts:722](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L722) + +Update tag's total chunks count. + +This is important if you are uploading individual chunks with a tag. Then upon finishing the final root chunk, +you can use this method to update the total chunks count for the tag. + +#### Parameters + +##### tagUid + +UID or tag object to be retrieved + +`number` | [`Tag`](../interfaces/Tag.md) + +##### reference + +The root reference that contains all the chunks to be counted + +`string` | [`Reference`](Reference.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +Options that affects the request behavior + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +TypeError if tagUid is in not correct format + +#### Throws + +BeeResponse error if something went wrong on the Bee node side while deleting the tag. + +#### See + + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + - [Bee API reference - `PATCH /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/patch) + +#### Inherited from + +[`Bee`](Bee.md).[`updateTag`](Bee.md#updatetag) + +*** + +### uploadChunk() + +> **uploadChunk**(`stamp`, `data`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:288](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L288) + +Upload chunk to a Bee node + +#### Parameters + +##### stamp + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) | [`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md) + +##### data + +Raw chunk to be uploaded + +`Uint8Array`\<`ArrayBufferLike`\> | `Chunk` + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +Additional options like tag, encryption, pinning, content-type and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +reference is a content hash of the data + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `POST /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post) + +#### Inherited from + +[`Bee`](Bee.md).[`uploadChunk`](Bee.md#uploadchunk) + +*** + +### uploadCollection() + +> **uploadCollection**(`postageBatchId`, `collection`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:593](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L593) + +Upload Collection that you can assembly yourself. + +The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment. +This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406 + +#### Parameters + +##### postageBatchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### collection + +[`Collection`](../type-aliases/Collection.md) + +##### options? + +[`CollectionUploadOptions`](../interfaces/CollectionUploadOptions.md) + +Collections and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### Inherited from + +[`Bee`](Bee.md).[`uploadCollection`](Bee.md#uploadcollection) + +*** + +### uploadData() + +> **uploadData**(`postageBatchId`, `data`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:203](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L203) + +Upload data to a Bee node + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### data + +Data to be uploaded + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### options? + +[`RedundantUploadOptions`](../interfaces/RedundantUploadOptions.md) + +Additional options like tag, encryption, pinning, content-type and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +reference is a content hash of the data + +#### See + + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `POST /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes/post) + +#### Inherited from + +[`Bee`](Bee.md).[`uploadData`](Bee.md#uploaddata) + +*** + +### uploadFile() + +> **uploadFile**(`postageBatchId`, `data`, `name?`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:420](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L420) + +Upload single file to a Bee node. + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### data + +Data or file to be uploaded + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | `File` | `Readable` + +##### name? + +`string` + +Optional name of the uploaded file + +##### options? + +[`FileUploadOptions`](../interfaces/FileUploadOptions.md) + +Additional options like tag, encryption, pinning, content-type and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +reference is a content hash of the file + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +#### Inherited from + +[`Bee`](Bee.md).[`uploadFile`](Bee.md#uploadfile) + +*** + +### uploadFiles() + +> **uploadFiles**(`postageBatchId`, `fileList`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:524](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L524) + +Upload collection of files to a Bee node + +Uses the FileList API from the browser. + +The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment. +This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406 + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### fileList + +list of files to be uploaded + +`File`[] | `FileList` + +##### options? + +[`CollectionUploadOptions`](../interfaces/CollectionUploadOptions.md) + +Additional options like tag, encryption, pinning and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee docs - Upload directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +#### Inherited from + +[`Bee`](Bee.md).[`uploadFiles`](Bee.md#uploadfiles) + +*** + +### uploadFilesFromDirectory() + +> **uploadFilesFromDirectory**(`postageBatchId`, `dir`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/bee.ts:625](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L625) + +Upload collection of files. + +Available only in Node.js as it uses the `fs` module. + +The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment. +This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406 + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### dir + +`string` + +the path of the files to be uploaded + +##### options? + +[`CollectionUploadOptions`](../interfaces/CollectionUploadOptions.md) + +Additional options like tag, encryption, pinning and request options + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +#### See + + - [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive) + - [Bee docs - Upload directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +#### Inherited from + +[`Bee`](Bee.md).[`uploadFilesFromDirectory`](Bee.md#uploadfilesfromdirectory) + +*** + +### withdrawTokens() + +> **withdrawTokens**(`amount`, `gasPrice?`, `options?`): `Promise`\<[`TransactionId`](TransactionId.md)\> + +Defined in: [bee-js/src/bee.ts:1470](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L1470) + +Withdraw tokens from the chequebook to the overlay address + +#### Parameters + +##### amount + +Amount of tokens to withdraw (must be positive integer) + +`string` | `bigint` | [`BZZ`](BZZ.md) | [`NumberString`](../type-aliases/NumberString.md) + +##### gasPrice? + +Gas Price in WEI for the transaction call + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +##### options? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`TransactionId`](TransactionId.md)\> + +string Hash of the transaction + +#### Inherited from + +[`Bee`](Bee.md).[`withdrawTokens`](Bee.md#withdrawtokens) diff --git a/docs/api/classes/BeeError.md b/docs/api/classes/BeeError.md new file mode 100644 index 00000000..ee3c0177 --- /dev/null +++ b/docs/api/classes/BeeError.md @@ -0,0 +1,40 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeError + +# Class: BeeError + +Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L1) + +## Extends + +- `Error` + +## Extended by + +- [`BeeArgumentError`](BeeArgumentError.md) +- [`BeeResponseError`](BeeResponseError.md) + +## Constructors + +### Constructor + +> **new BeeError**(`message`): `BeeError` + +Defined in: [bee-js/src/utils/error.ts:2](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L2) + +#### Parameters + +##### message + +`string` + +#### Returns + +`BeeError` + +#### Overrides + +`Error.constructor` diff --git a/docs/api/classes/BeeResponseError.md b/docs/api/classes/BeeResponseError.md new file mode 100644 index 00000000..7482560a --- /dev/null +++ b/docs/api/classes/BeeResponseError.md @@ -0,0 +1,95 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeResponseError + +# Class: BeeResponseError + +Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L13) + +## Extends + +- [`BeeError`](BeeError.md) + +## Constructors + +### Constructor + +> **new BeeResponseError**(`method`, `url`, `message`, `responseBody?`, `status?`, `statusText?`): `BeeResponseError` + +Defined in: [bee-js/src/utils/error.ts:14](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L14) + +#### Parameters + +##### method + +`string` + +##### url + +`string` + +##### message + +`string` + +##### responseBody? + +`unknown` + +##### status? + +`number` + +##### statusText? + +`string` + +#### Returns + +`BeeResponseError` + +#### Overrides + +[`BeeError`](BeeError.md).[`constructor`](BeeError.md#constructor) + +## Properties + +### method + +> **method**: `string` + +Defined in: [bee-js/src/utils/error.ts:15](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L15) + +*** + +### responseBody? + +> `optional` **responseBody**: `unknown` + +Defined in: [bee-js/src/utils/error.ts:18](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L18) + +*** + +### status? + +> `optional` **status**: `number` + +Defined in: [bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L19) + +*** + +### statusText? + +> `optional` **statusText**: `string` + +Defined in: [bee-js/src/utils/error.ts:20](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L20) + +*** + +### url + +> **url**: `string` + +Defined in: [bee-js/src/utils/error.ts:16](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L16) diff --git a/docs/api/classes/Bytes.md b/docs/api/classes/Bytes.md new file mode 100644 index 00000000..daacce40 --- /dev/null +++ b/docs/api/classes/Bytes.md @@ -0,0 +1,244 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Bytes + +# Class: Bytes + +Defined in: [bee-js/src/utils/bytes.ts:6](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L6) + +## Extended by + +- [`PrivateKey`](PrivateKey.md) +- [`PublicKey`](PublicKey.md) +- [`EthAddress`](EthAddress.md) +- [`Identifier`](Identifier.md) +- [`Reference`](Reference.md) +- [`TransactionId`](TransactionId.md) +- [`Span`](Span.md) +- [`PeerAddress`](PeerAddress.md) +- [`BatchId`](BatchId.md) +- [`Signature`](Signature.md) +- [`Topic`](Topic.md) +- [`FeedIndex`](FeedIndex.md) + +## Constructors + +### Constructor + +> **new Bytes**(`bytes`, `byteLength?`): `Bytes` + +Defined in: [bee-js/src/utils/bytes.ts:10](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L10) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | `Bytes` + +##### byteLength? + +`number` | `number`[] + +#### Returns + +`Bytes` + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | `Bytes` + +#### Returns + +`boolean` + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): `Bytes` + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +`Bytes` + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): `Bytes` + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +`Bytes` + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): `Bytes` + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | `Bytes` + +#### Returns + +`Bytes` diff --git a/docs/api/classes/DAI.md b/docs/api/classes/DAI.md new file mode 100644 index 00000000..e0fb63bf --- /dev/null +++ b/docs/api/classes/DAI.md @@ -0,0 +1,287 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / DAI + +# Class: DAI + +Defined in: [bee-js/src/utils/tokens.ts:94](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L94) + +## Properties + +### DIGITS + +> `readonly` `static` **DIGITS**: `18` = `18` + +Defined in: [bee-js/src/utils/tokens.ts:95](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L95) + +## Methods + +### divide() + +> **divide**(`other`): `DAI` + +Defined in: [bee-js/src/utils/tokens.ts:153](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L153) + +Does not mutate the current DAI instance. + +#### Parameters + +##### other + +`bigint` + +Divisor + +#### Returns + +`DAI` + +New DAI instance + +*** + +### eq() + +> **eq**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:173](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L173) + +#### Parameters + +##### other + +`DAI` + +#### Returns + +`boolean` + +*** + +### exchangeToBZZ() + +> **exchangeToBZZ**(`daiPerBzz`): [`BZZ`](BZZ.md) + +Defined in: [bee-js/src/utils/tokens.ts:177](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L177) + +#### Parameters + +##### daiPerBzz + +`DAI` + +#### Returns + +[`BZZ`](BZZ.md) + +*** + +### gt() + +> **gt**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:157](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L157) + +#### Parameters + +##### other + +`DAI` + +#### Returns + +`boolean` + +*** + +### gte() + +> **gte**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:161](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L161) + +#### Parameters + +##### other + +`DAI` + +#### Returns + +`boolean` + +*** + +### lt() + +> **lt**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:165](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L165) + +#### Parameters + +##### other + +`DAI` + +#### Returns + +`boolean` + +*** + +### lte() + +> **lte**(`other`): `boolean` + +Defined in: [bee-js/src/utils/tokens.ts:169](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L169) + +#### Parameters + +##### other + +`DAI` + +#### Returns + +`boolean` + +*** + +### minus() + +> **minus**(`other`): `DAI` + +Defined in: [bee-js/src/utils/tokens.ts:143](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L143) + +Does not mutate the current DAI instance. + +#### Parameters + +##### other + +DAI instance, or amount in PLUR + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) | `DAI` + +#### Returns + +`DAI` + +New DAI instance + +*** + +### plus() + +> **plus**(`other`): `DAI` + +Defined in: [bee-js/src/utils/tokens.ts:133](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L133) + +Does not mutate the current DAI instance. + +#### Parameters + +##### other + +DAI instance, or amount in PLUR + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) | `DAI` + +#### Returns + +`DAI` + +New DAI instance + +*** + +### toDecimalString() + +> **toDecimalString**(): `string` + +Defined in: [bee-js/src/utils/tokens.ts:119](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L119) + +#### Returns + +`string` + +*** + +### toSignificantDigits() + +> **toSignificantDigits**(`digits`): `string` + +Defined in: [bee-js/src/utils/tokens.ts:123](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L123) + +#### Parameters + +##### digits + +`number` + +#### Returns + +`string` + +*** + +### toWeiBigInt() + +> **toWeiBigInt**(): `bigint` + +Defined in: [bee-js/src/utils/tokens.ts:115](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L115) + +#### Returns + +`bigint` + +*** + +### toWeiString() + +> **toWeiString**(): `string` + +Defined in: [bee-js/src/utils/tokens.ts:111](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L111) + +#### Returns + +`string` + +*** + +### fromDecimalString() + +> `static` **fromDecimalString**(`string`): `DAI` + +Defined in: [bee-js/src/utils/tokens.ts:103](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L103) + +#### Parameters + +##### string + +`string` + +#### Returns + +`DAI` + +*** + +### fromWei() + +> `static` **fromWei**(`wei`): `DAI` + +Defined in: [bee-js/src/utils/tokens.ts:107](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L107) + +#### Parameters + +##### wei + +`string` | `bigint` | [`NumberString`](../type-aliases/NumberString.md) + +#### Returns + +`DAI` diff --git a/docs/api/classes/Duration.md b/docs/api/classes/Duration.md new file mode 100644 index 00000000..b656f462 --- /dev/null +++ b/docs/api/classes/Duration.md @@ -0,0 +1,217 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Duration + +# Class: Duration + +Defined in: [bee-js/src/utils/duration.ts:1](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L1) + +## Methods + +### toDays() + +> **toDays**(): `number` + +Defined in: [bee-js/src/utils/duration.ts:48](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L48) + +#### Returns + +`number` + +*** + +### toEndDate() + +> **toEndDate**(`startDate?`): `Date` + +Defined in: [bee-js/src/utils/duration.ts:60](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L60) + +#### Parameters + +##### startDate? + +`Date` + +#### Returns + +`Date` + +*** + +### toHours() + +> **toHours**(): `number` + +Defined in: [bee-js/src/utils/duration.ts:44](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L44) + +#### Returns + +`number` + +*** + +### toSeconds() + +> **toSeconds**(): `number` + +Defined in: [bee-js/src/utils/duration.ts:40](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L40) + +#### Returns + +`number` + +*** + +### toWeeks() + +> **toWeeks**(): `number` + +Defined in: [bee-js/src/utils/duration.ts:52](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L52) + +#### Returns + +`number` + +*** + +### toYears() + +> **toYears**(): `number` + +Defined in: [bee-js/src/utils/duration.ts:56](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L56) + +#### Returns + +`number` + +*** + +### fromDays() + +> `static` **fromDays**(`days`): `Duration` + +Defined in: [bee-js/src/utils/duration.ts:24](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L24) + +#### Parameters + +##### days + +`number` + +#### Returns + +`Duration` + +*** + +### fromEndDate() + +> `static` **fromEndDate**(`endDate`, `startDate?`): `Duration` + +Defined in: [bee-js/src/utils/duration.ts:36](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L36) + +#### Parameters + +##### endDate + +`Date` + +##### startDate? + +`Date` + +#### Returns + +`Duration` + +*** + +### fromHours() + +> `static` **fromHours**(`hours`): `Duration` + +Defined in: [bee-js/src/utils/duration.ts:20](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L20) + +#### Parameters + +##### hours + +`number` + +#### Returns + +`Duration` + +*** + +### fromMilliseconds() + +> `static` **fromMilliseconds**(`milliseconds`): `Duration` + +Defined in: [bee-js/src/utils/duration.ts:12](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L12) + +#### Parameters + +##### milliseconds + +`number` + +#### Returns + +`Duration` + +*** + +### fromSeconds() + +> `static` **fromSeconds**(`seconds`): `Duration` + +Defined in: [bee-js/src/utils/duration.ts:16](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L16) + +#### Parameters + +##### seconds + +`number` + +#### Returns + +`Duration` + +*** + +### fromWeeks() + +> `static` **fromWeeks**(`weeks`): `Duration` + +Defined in: [bee-js/src/utils/duration.ts:28](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L28) + +#### Parameters + +##### weeks + +`number` + +#### Returns + +`Duration` + +*** + +### fromYears() + +> `static` **fromYears**(`years`): `Duration` + +Defined in: [bee-js/src/utils/duration.ts:32](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L32) + +#### Parameters + +##### years + +`number` + +#### Returns + +`Duration` diff --git a/docs/api/classes/EthAddress.md b/docs/api/classes/EthAddress.md new file mode 100644 index 00000000..c2a71b00 --- /dev/null +++ b/docs/api/classes/EthAddress.md @@ -0,0 +1,309 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / EthAddress + +# Class: EthAddress + +Defined in: [bee-js/src/utils/typed-bytes.ts:66](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L66) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new EthAddress**(`bytes`): `EthAddress` + +Defined in: [bee-js/src/utils/typed-bytes.ts:68](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L68) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`EthAddress` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `20` = `20` + +Defined in: [bee-js/src/utils/typed-bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L67) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toChecksum() + +> **toChecksum**(): `string` + +Defined in: [bee-js/src/utils/typed-bytes.ts:72](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L72) + +#### Returns + +`string` + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/FeedIndex.md b/docs/api/classes/FeedIndex.md new file mode 100644 index 00000000..6896ec24 --- /dev/null +++ b/docs/api/classes/FeedIndex.md @@ -0,0 +1,347 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / FeedIndex + +# Class: FeedIndex + +Defined in: [bee-js/src/utils/typed-bytes.ts:202](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L202) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new FeedIndex**(`bytes`): `FeedIndex` + +Defined in: [bee-js/src/utils/typed-bytes.ts:206](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L206) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`FeedIndex` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `8` = `8` + +Defined in: [bee-js/src/utils/typed-bytes.ts:203](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L203) + +*** + +### MINUS\_ONE + +> `readonly` `static` **MINUS\_ONE**: `FeedIndex` + +Defined in: [bee-js/src/utils/typed-bytes.ts:204](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L204) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### next() + +> **next**(): `FeedIndex` + +Defined in: [bee-js/src/utils/typed-bytes.ts:218](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L218) + +#### Returns + +`FeedIndex` + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [bee-js/src/utils/typed-bytes.ts:214](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L214) + +#### Returns + +`bigint` + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromBigInt() + +> `static` **fromBigInt**(`number`): `FeedIndex` + +Defined in: [bee-js/src/utils/typed-bytes.ts:210](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L210) + +#### Parameters + +##### number + +`bigint` + +#### Returns + +`FeedIndex` + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/Identifier.md b/docs/api/classes/Identifier.md new file mode 100644 index 00000000..5764be9b --- /dev/null +++ b/docs/api/classes/Identifier.md @@ -0,0 +1,315 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Identifier + +# Class: Identifier + +Defined in: [bee-js/src/utils/typed-bytes.ts:77](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L77) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new Identifier**(`bytes`): `Identifier` + +Defined in: [bee-js/src/utils/typed-bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L79) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`Identifier` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `32` = `32` + +Defined in: [bee-js/src/utils/typed-bytes.ts:78](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L78) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromString() + +> `static` **fromString**(`value`): `Identifier` + +Defined in: [bee-js/src/utils/typed-bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L83) + +#### Parameters + +##### value + +`string` + +#### Returns + +`Identifier` + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/MantarayNode.md b/docs/api/classes/MantarayNode.md new file mode 100644 index 00000000..6814e541 --- /dev/null +++ b/docs/api/classes/MantarayNode.md @@ -0,0 +1,461 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / MantarayNode + +# Class: MantarayNode + +Defined in: [bee-js/src/manifest/manifest.ts:121](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L121) + +## Constructors + +### Constructor + +> **new MantarayNode**(`options?`): `MantarayNode` + +Defined in: [bee-js/src/manifest/manifest.ts:130](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L130) + +#### Parameters + +##### options? + +`MantarayNodeOptions` + +#### Returns + +`MantarayNode` + +## Properties + +### forks + +> **forks**: `Map`\<`number`, `Fork`\> + +Defined in: [bee-js/src/manifest/manifest.ts:127](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L127) + +*** + +### metadata + +> **metadata**: `undefined` \| `null` \| `Record`\<`string`, `string`\> = `null` + +Defined in: [bee-js/src/manifest/manifest.ts:125](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L125) + +*** + +### obfuscationKey + +> **obfuscationKey**: `Uint8Array` + +Defined in: [bee-js/src/manifest/manifest.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L122) + +*** + +### parent + +> **parent**: `null` \| `MantarayNode` = `null` + +Defined in: [bee-js/src/manifest/manifest.ts:128](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L128) + +*** + +### path + +> **path**: `Uint8Array` + +Defined in: [bee-js/src/manifest/manifest.ts:126](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L126) + +*** + +### selfAddress + +> **selfAddress**: `null` \| `Uint8Array`\<`ArrayBufferLike`\> = `null` + +Defined in: [bee-js/src/manifest/manifest.ts:123](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L123) + +*** + +### targetAddress + +> **targetAddress**: `Uint8Array` + +Defined in: [bee-js/src/manifest/manifest.ts:124](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L124) + +## Accessors + +### fullPath + +#### Get Signature + +> **get** **fullPath**(): `Uint8Array` + +Defined in: [bee-js/src/manifest/manifest.ts:156](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L156) + +##### Returns + +`Uint8Array` + +*** + +### fullPathString + +#### Get Signature + +> **get** **fullPathString**(): `string` + +Defined in: [bee-js/src/manifest/manifest.ts:160](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L160) + +##### Returns + +`string` + +## Methods + +### addFork() + +> **addFork**(`path`, `reference`, `metadata?`): `void` + +Defined in: [bee-js/src/manifest/manifest.ts:307](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L307) + +Adds a fork to the node. + +#### Parameters + +##### path + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) | [`Reference`](Reference.md) + +##### metadata? + +`null` | `Record`\<`string`, `string`\> + +#### Returns + +`void` + +*** + +### calculateSelfAddress() + +> **calculateSelfAddress**(): `Promise`\<[`Reference`](Reference.md)\> + +Defined in: [bee-js/src/manifest/manifest.ts:387](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L387) + +Calculates the self address of the node. + +#### Returns + +`Promise`\<[`Reference`](Reference.md)\> + +*** + +### collect() + +> **collect**(`nodes`): `MantarayNode`[] + +Defined in: [bee-js/src/manifest/manifest.ts:463](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L463) + +Returns an array of all nodes in the tree which have a target address set. + +Must be called after `loadRecursively`. + +#### Parameters + +##### nodes + +`MantarayNode`[] = `[]` + +#### Returns + +`MantarayNode`[] + +*** + +### collectAndMap() + +> **collectAndMap**(): `Record`\<`string`, `string`\> + +Defined in: [bee-js/src/manifest/manifest.ts:479](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L479) + +Returns a path:reference map of all nodes in the tree which have a target address set. + +Must be called after `loadRecursively`. + +#### Returns + +`Record`\<`string`, `string`\> + +*** + +### determineType() + +> **determineType**(): `number` + +Defined in: [bee-js/src/manifest/manifest.ts:490](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L490) + +#### Returns + +`number` + +*** + +### find() + +> **find**(`path`): `null` \| `MantarayNode` + +Defined in: [bee-js/src/manifest/manifest.ts:433](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L433) + +Finds a node in the tree by its path. + +#### Parameters + +##### path + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +#### Returns + +`null` \| `MantarayNode` + +*** + +### findClosest() + +> **findClosest**(`path`, `current`): \[`MantarayNode`, `Uint8Array`\<`ArrayBufferLike`\>\] + +Defined in: [bee-js/src/manifest/manifest.ts:442](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L442) + +Finds the closest node in the tree to the given path. + +#### Parameters + +##### path + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### current + +`Uint8Array` = `...` + +#### Returns + +\[`MantarayNode`, `Uint8Array`\<`ArrayBufferLike`\>\] + +*** + +### getDocsMetadata() + +> **getDocsMetadata**(): `object` + +Defined in: [bee-js/src/manifest/manifest.ts:180](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L180) + +Returns the `swarm-index-document` and `swarm-error-document` metadata values. + +#### Returns + +`object` + +##### errorDocument + +> **errorDocument**: `null` \| `string` + +##### indexDocument + +> **indexDocument**: `null` \| `string` + +*** + +### getRootMetadata() + +> **getRootMetadata**(): `Optional`\<`Record`\<`string`, `string`\>\> + +Defined in: [bee-js/src/manifest/manifest.ts:167](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L167) + +Returns the metadata at the `/` path to access idiomatic properties. + +#### Returns + +`Optional`\<`Record`\<`string`, `string`\>\> + +*** + +### loadRecursively() + +> **loadRecursively**(`bee`, `options?`, `requestOptions?`): `Promise`\<`void`\> + +Defined in: [bee-js/src/manifest/manifest.ts:416](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L416) + +Loads the node and its children recursively. + +#### Parameters + +##### bee + +[`Bee`](Bee.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### marshal() + +> **marshal**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [bee-js/src/manifest/manifest.ts:219](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L219) + +Gets the binary representation of the node. + +#### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +*** + +### removeFork() + +> **removeFork**(`path`): `void` + +Defined in: [bee-js/src/manifest/manifest.ts:362](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L362) + +Removes a fork from the node. + +#### Parameters + +##### path + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +#### Returns + +`void` + +*** + +### resolveFeed() + +> **resolveFeed**(`bee`, `requestOptions?`): `Promise`\<`Optional`\<`FeedPayloadResult`\>\> + +Defined in: [bee-js/src/manifest/manifest.ts:199](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L199) + +Attempts to resolve the manifest as a feed, returning the latest update. + +#### Parameters + +##### bee + +[`Bee`](Bee.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`Optional`\<`FeedPayloadResult`\>\> + +*** + +### saveRecursively() + +> **saveRecursively**(`bee`, `postageBatchId`, `options?`, `requestOptions?`): `Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +Defined in: [bee-js/src/manifest/manifest.ts:398](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L398) + +Saves the node and its children recursively. + +#### Parameters + +##### bee + +[`Bee`](Bee.md) + +##### postageBatchId + +`string` | [`BatchId`](BatchId.md) + +##### options? + +[`UploadOptions`](../interfaces/UploadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<[`UploadResult`](../interfaces/UploadResult.md)\> + +*** + +### unmarshal() + +> `static` **unmarshal**(`bee`, `reference`, `options?`, `requestOptions?`): `Promise`\<`MantarayNode`\> + +Defined in: [bee-js/src/manifest/manifest.ts:263](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L263) + +Downloads and unmarshals a MantarayNode from the given reference. + +Do not forget calling `loadRecursively` on the returned node to load the entire tree. + +#### Parameters + +##### bee + +[`Bee`](Bee.md) + +##### reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](Reference.md) + +##### options? + +[`DownloadOptions`](../interfaces/DownloadOptions.md) + +##### requestOptions? + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +#### Returns + +`Promise`\<`MantarayNode`\> + +*** + +### unmarshalFromData() + +> `static` **unmarshalFromData**(`data`, `selfAddress`): `MantarayNode` + +Defined in: [bee-js/src/manifest/manifest.ts:280](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L280) + +Unmarshals a MantarayNode from the given data. + +Do not forget calling `loadRecursively` on the returned node to load the entire tree. + +#### Parameters + +##### data + +`Uint8Array` + +##### selfAddress + +`Uint8Array` + +#### Returns + +`MantarayNode` diff --git a/docs/api/classes/PeerAddress.md b/docs/api/classes/PeerAddress.md new file mode 100644 index 00000000..15a0c41e --- /dev/null +++ b/docs/api/classes/PeerAddress.md @@ -0,0 +1,297 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PeerAddress + +# Class: PeerAddress + +Defined in: [bee-js/src/utils/typed-bytes.ts:140](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L140) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new PeerAddress**(`bytes`): `PeerAddress` + +Defined in: [bee-js/src/utils/typed-bytes.ts:142](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L142) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`PeerAddress` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `32` = `32` + +Defined in: [bee-js/src/utils/typed-bytes.ts:141](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L141) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/PrivateKey.md b/docs/api/classes/PrivateKey.md new file mode 100644 index 00000000..d19ec912 --- /dev/null +++ b/docs/api/classes/PrivateKey.md @@ -0,0 +1,327 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PrivateKey + +# Class: PrivateKey + +Defined in: [bee-js/src/utils/typed-bytes.ts:9](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L9) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new PrivateKey**(`bytes`): `PrivateKey` + +Defined in: [bee-js/src/utils/typed-bytes.ts:11](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L11) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`PrivateKey` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `32` = `32` + +Defined in: [bee-js/src/utils/typed-bytes.ts:10](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L10) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### publicKey() + +> **publicKey**(): [`PublicKey`](PublicKey.md) + +Defined in: [bee-js/src/utils/typed-bytes.ts:15](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L15) + +#### Returns + +[`PublicKey`](PublicKey.md) + +*** + +### sign() + +> **sign**(`data`): [`Signature`](Signature.md) + +Defined in: [bee-js/src/utils/typed-bytes.ts:21](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L21) + +#### Parameters + +##### data + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +#### Returns + +[`Signature`](Signature.md) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/PublicKey.md b/docs/api/classes/PublicKey.md new file mode 100644 index 00000000..0c24b6f0 --- /dev/null +++ b/docs/api/classes/PublicKey.md @@ -0,0 +1,333 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PublicKey + +# Class: PublicKey + +Defined in: [bee-js/src/utils/typed-bytes.ts:34](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L34) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new PublicKey**(`bytes`): `PublicKey` + +Defined in: [bee-js/src/utils/typed-bytes.ts:36](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L36) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`PublicKey` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `64` = `64` + +Defined in: [bee-js/src/utils/typed-bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L35) + +## Methods + +### address() + +> **address**(): [`EthAddress`](EthAddress.md) + +Defined in: [bee-js/src/utils/typed-bytes.ts:47](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L47) + +#### Returns + +[`EthAddress`](EthAddress.md) + +*** + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toCompressedHex() + +> **toCompressedHex**(): `string` + +Defined in: [bee-js/src/utils/typed-bytes.ts:61](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L61) + +#### Returns + +`string` + +*** + +### toCompressedUint8Array() + +> **toCompressedUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/typed-bytes.ts:54](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L54) + +#### Returns + +`Uint8Array` + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/Reference.md b/docs/api/classes/Reference.md new file mode 100644 index 00000000..16726e3b --- /dev/null +++ b/docs/api/classes/Reference.md @@ -0,0 +1,333 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Reference + +# Class: Reference + +Defined in: [bee-js/src/utils/typed-bytes.ts:88](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L88) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new Reference**(`bytes`): `Reference` + +Defined in: [bee-js/src/utils/typed-bytes.ts:90](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L90) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`Reference` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `32` = `32` + +Defined in: [bee-js/src/utils/typed-bytes.ts:89](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L89) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toCid() + +> **toCid**(`type`): `string` + +Defined in: [bee-js/src/utils/typed-bytes.ts:99](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L99) + +#### Parameters + +##### type + +`"manifest"` | `"feed"` + +#### Returns + +`string` + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### isValid() + +> `static` **isValid**(`value`): `boolean` + +Defined in: [bee-js/src/utils/typed-bytes.ts:103](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L103) + +#### Parameters + +##### value + +`string` + +#### Returns + +`boolean` + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/Signature.md b/docs/api/classes/Signature.md new file mode 100644 index 00000000..6fb56960 --- /dev/null +++ b/docs/api/classes/Signature.md @@ -0,0 +1,333 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Signature + +# Class: Signature + +Defined in: [bee-js/src/utils/typed-bytes.ts:154](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L154) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new Signature**(`bytes`): `Signature` + +Defined in: [bee-js/src/utils/typed-bytes.ts:156](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L156) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`Signature` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `65` = `65` + +Defined in: [bee-js/src/utils/typed-bytes.ts:155](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L155) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### isValid() + +> **isValid**(`digest`, `expectedAddress`): `boolean` + +Defined in: [bee-js/src/utils/typed-bytes.ts:181](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L181) + +#### Parameters + +##### digest + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### expectedAddress + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`EthAddress`](EthAddress.md) + +#### Returns + +`boolean` + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### recoverPublicKey() + +> **recoverPublicKey**(`digest`): [`PublicKey`](PublicKey.md) + +Defined in: [bee-js/src/utils/typed-bytes.ts:164](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L164) + +#### Parameters + +##### digest + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +#### Returns + +[`PublicKey`](PublicKey.md) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`): `Signature` + +Defined in: [bee-js/src/utils/typed-bytes.ts:160](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L160) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +#### Returns + +`Signature` + +#### Overrides + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/Size.md b/docs/api/classes/Size.md new file mode 100644 index 00000000..ae211e5d --- /dev/null +++ b/docs/api/classes/Size.md @@ -0,0 +1,123 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Size + +# Class: Size + +Defined in: [bee-js/src/utils/size.ts:10](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L10) + +Represents a size in bytes. + +Uses 1000 instead of 1024 for converting between units. +This is to stay consistent with the Swarm papers +on theoretical and effective storage capacity. + +## Methods + +### toBytes() + +> **toBytes**(): `number` + +Defined in: [bee-js/src/utils/size.ts:37](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L37) + +#### Returns + +`number` + +*** + +### toFormattedString() + +> **toFormattedString**(): `string` + +Defined in: [bee-js/src/utils/size.ts:45](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L45) + +#### Returns + +`string` + +*** + +### toGigabytes() + +> **toGigabytes**(): `number` + +Defined in: [bee-js/src/utils/size.ts:41](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L41) + +#### Returns + +`number` + +*** + +### fromBytes() + +> `static` **fromBytes**(`bytes`): `Size` + +Defined in: [bee-js/src/utils/size.ts:21](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L21) + +#### Parameters + +##### bytes + +`number` + +#### Returns + +`Size` + +*** + +### fromGigabytes() + +> `static` **fromGigabytes**(`gigabytes`): `Size` + +Defined in: [bee-js/src/utils/size.ts:33](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L33) + +#### Parameters + +##### gigabytes + +`number` + +#### Returns + +`Size` + +*** + +### fromKilobytes() + +> `static` **fromKilobytes**(`kilobytes`): `Size` + +Defined in: [bee-js/src/utils/size.ts:25](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L25) + +#### Parameters + +##### kilobytes + +`number` + +#### Returns + +`Size` + +*** + +### fromMegabytes() + +> `static` **fromMegabytes**(`megabytes`): `Size` + +Defined in: [bee-js/src/utils/size.ts:29](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L29) + +#### Parameters + +##### megabytes + +`number` + +#### Returns + +`Size` diff --git a/docs/api/classes/Span.md b/docs/api/classes/Span.md new file mode 100644 index 00000000..50906735 --- /dev/null +++ b/docs/api/classes/Span.md @@ -0,0 +1,323 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Span + +# Class: Span + +Defined in: [bee-js/src/utils/typed-bytes.ts:121](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L121) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new Span**(`bytes`): `Span` + +Defined in: [bee-js/src/utils/typed-bytes.ts:123](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L123) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`Span` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `8` = `8` + +Defined in: [bee-js/src/utils/typed-bytes.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L122) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [bee-js/src/utils/typed-bytes.ts:131](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L131) + +#### Returns + +`bigint` + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromBigInt() + +> `static` **fromBigInt**(`number`): `Span` + +Defined in: [bee-js/src/utils/typed-bytes.ts:127](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L127) + +#### Parameters + +##### number + +`bigint` + +#### Returns + +`Span` + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`): `Span` + +Defined in: [bee-js/src/utils/typed-bytes.ts:135](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L135) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +#### Returns + +`Span` + +#### Overrides + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/Stamper.md b/docs/api/classes/Stamper.md new file mode 100644 index 00000000..354c4923 --- /dev/null +++ b/docs/api/classes/Stamper.md @@ -0,0 +1,135 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Stamper + +# Class: Stamper + +Defined in: [bee-js/src/stamper/stamper.ts:5](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L5) + +## Properties + +### batchId + +> **batchId**: [`BatchId`](BatchId.md) + +Defined in: [bee-js/src/stamper/stamper.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L7) + +*** + +### buckets + +> **buckets**: `Uint32Array` + +Defined in: [bee-js/src/stamper/stamper.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L8) + +*** + +### depth + +> **depth**: `number` + +Defined in: [bee-js/src/stamper/stamper.ts:9](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L9) + +*** + +### maxSlot + +> **maxSlot**: `number` + +Defined in: [bee-js/src/stamper/stamper.ts:10](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L10) + +*** + +### signer + +> **signer**: [`PrivateKey`](PrivateKey.md) + +Defined in: [bee-js/src/stamper/stamper.ts:6](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L6) + +## Methods + +### getState() + +> **getState**(): `Uint32Array` + +Defined in: [bee-js/src/stamper/stamper.ts:60](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L60) + +#### Returns + +`Uint32Array` + +*** + +### stamp() + +> **stamp**(`chunk`): [`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md) + +Defined in: [bee-js/src/stamper/stamper.ts:38](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L38) + +#### Parameters + +##### chunk + +`Chunk` + +#### Returns + +[`EnvelopeWithBatchId`](../interfaces/EnvelopeWithBatchId.md) + +*** + +### fromBlank() + +> `static` **fromBlank**(`signer`, `batchId`, `depth`): `Stamper` + +Defined in: [bee-js/src/stamper/stamper.ts:25](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L25) + +#### Parameters + +##### signer + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### batchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### depth + +`number` + +#### Returns + +`Stamper` + +*** + +### fromState() + +> `static` **fromState**(`signer`, `batchId`, `buckets`, `depth`): `Stamper` + +Defined in: [bee-js/src/stamper/stamper.ts:29](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L29) + +#### Parameters + +##### signer + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PrivateKey`](PrivateKey.md) + +##### batchId + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](BatchId.md) + +##### buckets + +`Uint32Array` + +##### depth + +`number` + +#### Returns + +`Stamper` diff --git a/docs/api/classes/Topic.md b/docs/api/classes/Topic.md new file mode 100644 index 00000000..0912a65e --- /dev/null +++ b/docs/api/classes/Topic.md @@ -0,0 +1,315 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Topic + +# Class: Topic + +Defined in: [bee-js/src/utils/typed-bytes.ts:189](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L189) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new Topic**(`bytes`): `Topic` + +Defined in: [bee-js/src/utils/typed-bytes.ts:191](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L191) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`Topic` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `32` = `32` + +Defined in: [bee-js/src/utils/typed-bytes.ts:190](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L190) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromString() + +> `static` **fromString**(`value`): `Topic` + +Defined in: [bee-js/src/utils/typed-bytes.ts:195](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L195) + +#### Parameters + +##### value + +`string` + +#### Returns + +`Topic` + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/classes/TransactionId.md b/docs/api/classes/TransactionId.md new file mode 100644 index 00000000..35d72955 --- /dev/null +++ b/docs/api/classes/TransactionId.md @@ -0,0 +1,297 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / TransactionId + +# Class: TransactionId + +Defined in: [bee-js/src/utils/typed-bytes.ts:114](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L114) + +## Extends + +- [`Bytes`](Bytes.md) + +## Constructors + +### Constructor + +> **new TransactionId**(`bytes`): `TransactionId` + +Defined in: [bee-js/src/utils/typed-bytes.ts:116](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L116) + +#### Parameters + +##### bytes + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`TransactionId` + +#### Overrides + +[`Bytes`](Bytes.md).[`constructor`](Bytes.md#constructor) + +## Properties + +### bytes + +> `protected` `readonly` **bytes**: `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L7) + +#### Inherited from + +[`Bytes`](Bytes.md).[`bytes`](Bytes.md#bytes) + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: [bee-js/src/utils/bytes.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L8) + +#### Inherited from + +[`Bytes`](Bytes.md).[`length`](Bytes.md#length) + +*** + +### LENGTH + +> `readonly` `static` **LENGTH**: `32` = `32` + +Defined in: [bee-js/src/utils/typed-bytes.ts:115](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L115) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Defined in: [bee-js/src/utils/bytes.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L83) + +#### Parameters + +##### other + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Bytes`](Bytes.md).[`equals`](Bytes.md#equals) + +*** + +### offset() + +> **offset**(`index`): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L51) + +#### Parameters + +##### index + +`number` + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`offset`](Bytes.md#offset) + +*** + +### toBase32() + +> **toBase32**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L67) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase32`](Bytes.md#tobase32) + +*** + +### toBase64() + +> **toBase64**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L63) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toBase64`](Bytes.md#tobase64) + +*** + +### toHex() + +> **toHex**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L59) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toHex`](Bytes.md#tohex) + +*** + +### toJSON() + +> **toJSON**(): `unknown` + +Defined in: [bee-js/src/utils/bytes.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L79) + +#### Returns + +`unknown` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toJSON`](Bytes.md#tojson) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L71) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toString`](Bytes.md#tostring) + +*** + +### toUint8Array() + +> **toUint8Array**(): `Uint8Array` + +Defined in: [bee-js/src/utils/bytes.ts:55](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L55) + +#### Returns + +`Uint8Array` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUint8Array`](Bytes.md#touint8array) + +*** + +### toUtf8() + +> **toUtf8**(): `string` + +Defined in: [bee-js/src/utils/bytes.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L75) + +#### Returns + +`string` + +#### Inherited from + +[`Bytes`](Bytes.md).[`toUtf8`](Bytes.md#toutf8) + +*** + +### fromSlice() + +> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L43) + +#### Parameters + +##### bytes + +`Uint8Array` + +##### start + +`number` + +##### length? + +`number` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromSlice`](Bytes.md#fromslice) + +*** + +### fromUtf8() + +> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L39) + +#### Parameters + +##### utf8 + +`string` + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`fromUtf8`](Bytes.md#fromutf8) + +*** + +### keccak256() + +> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md) + +Defined in: [bee-js/src/utils/bytes.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L35) + +#### Parameters + +##### bytes + +`string` | `ArrayBuffer` | `Uint8Array`\<`ArrayBufferLike`\> | [`Bytes`](Bytes.md) + +#### Returns + +[`Bytes`](Bytes.md) + +#### Inherited from + +[`Bytes`](Bytes.md).[`keccak256`](Bytes.md#keccak256) diff --git a/docs/api/enumerations/BeeModes.md b/docs/api/enumerations/BeeModes.md new file mode 100644 index 00000000..b6f2886d --- /dev/null +++ b/docs/api/enumerations/BeeModes.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeModes + +# Enumeration: BeeModes + +Defined in: [bee-js/src/types/debug.ts:129](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L129) + +## Enumeration Members + +### DEV + +> **DEV**: `"dev"` + +Defined in: [bee-js/src/types/debug.ts:133](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L133) + +*** + +### FULL + +> **FULL**: `"full"` + +Defined in: [bee-js/src/types/debug.ts:130](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L130) + +*** + +### LIGHT + +> **LIGHT**: `"light"` + +Defined in: [bee-js/src/types/debug.ts:131](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L131) + +*** + +### ULTRA\_LIGHT + +> **ULTRA\_LIGHT**: `"ultra-light"` + +Defined in: [bee-js/src/types/debug.ts:132](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L132) diff --git a/docs/api/enumerations/RedundancyLevel.md b/docs/api/enumerations/RedundancyLevel.md new file mode 100644 index 00000000..16d17b07 --- /dev/null +++ b/docs/api/enumerations/RedundancyLevel.md @@ -0,0 +1,52 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / RedundancyLevel + +# Enumeration: RedundancyLevel + +Defined in: [bee-js/src/types/index.ts:150](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L150) + +Add redundancy to the data being uploaded so that downloaders can download it with better UX. +0 value is default and does not add any redundancy to the file. + +## Enumeration Members + +### INSANE + +> **INSANE**: `3` + +Defined in: [bee-js/src/types/index.ts:154](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L154) + +*** + +### MEDIUM + +> **MEDIUM**: `1` + +Defined in: [bee-js/src/types/index.ts:152](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L152) + +*** + +### OFF + +> **OFF**: `0` + +Defined in: [bee-js/src/types/index.ts:151](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L151) + +*** + +### PARANOID + +> **PARANOID**: `4` + +Defined in: [bee-js/src/types/index.ts:155](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L155) + +*** + +### STRONG + +> **STRONG**: `2` + +Defined in: [bee-js/src/types/index.ts:153](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L153) diff --git a/docs/api/enumerations/RedundancyStrategy.md b/docs/api/enumerations/RedundancyStrategy.md new file mode 100644 index 00000000..96f5c1d7 --- /dev/null +++ b/docs/api/enumerations/RedundancyStrategy.md @@ -0,0 +1,50 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / RedundancyStrategy + +# Enumeration: RedundancyStrategy + +Defined in: [bee-js/src/types/index.ts:172](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L172) + +Specify the retrieve strategy on redundant data. +The possible values are NONE, DATA, PROX and RACE. +Strategy NONE means no prefetching takes place. +Strategy DATA means only data chunks are prefetched. +Strategy PROX means only chunks that are close to the node are prefetched. +Strategy RACE means all chunks are prefetched: n data chunks and k parity chunks. The first n chunks to arrive are used to reconstruct the file. +Multiple strategies can be used in a fallback cascade if the swarm redundancy fallback mode is set to true. +The default strategy is NONE, DATA, falling back to PROX, falling back to RACE + +## Enumeration Members + +### DATA + +> **DATA**: `1` + +Defined in: [bee-js/src/types/index.ts:174](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L174) + +*** + +### NONE + +> **NONE**: `0` + +Defined in: [bee-js/src/types/index.ts:173](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L173) + +*** + +### PROX + +> **PROX**: `2` + +Defined in: [bee-js/src/types/index.ts:175](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L175) + +*** + +### RACE + +> **RACE**: `3` + +Defined in: [bee-js/src/types/index.ts:176](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L176) diff --git a/docs/api/functions/toBeeMode.md b/docs/api/functions/toBeeMode.md new file mode 100644 index 00000000..b0673b5c --- /dev/null +++ b/docs/api/functions/toBeeMode.md @@ -0,0 +1,21 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / toBeeMode + +# Function: toBeeMode() + +> **toBeeMode**(`value`): [`BeeModes`](../enumerations/BeeModes.md) + +Defined in: [bee-js/src/types/debug.ts:136](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L136) + +## Parameters + +### value + +`string` + +## Returns + +[`BeeModes`](../enumerations/BeeModes.md) diff --git a/docs/api/interfaces/AllSettlements.md b/docs/api/interfaces/AllSettlements.md new file mode 100644 index 00000000..d987fe27 --- /dev/null +++ b/docs/api/interfaces/AllSettlements.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / AllSettlements + +# Interface: AllSettlements + +Defined in: [bee-js/src/types/debug.ts:11](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L11) + +## Properties + +### settlements + +> **settlements**: [`Settlements`](Settlements.md)[] + +Defined in: [bee-js/src/types/debug.ts:14](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L14) + +*** + +### totalReceived + +> **totalReceived**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:12](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L12) + +*** + +### totalSent + +> **totalSent**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:13](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L13) diff --git a/docs/api/interfaces/AllTagsOptions.md b/docs/api/interfaces/AllTagsOptions.md new file mode 100644 index 00000000..b2b924c5 --- /dev/null +++ b/docs/api/interfaces/AllTagsOptions.md @@ -0,0 +1,25 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / AllTagsOptions + +# Interface: AllTagsOptions + +Defined in: [bee-js/src/types/index.ts:262](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L262) + +## Properties + +### limit? + +> `optional` **limit**: `number` + +Defined in: [bee-js/src/types/index.ts:263](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L263) + +*** + +### offset? + +> `optional` **offset**: `number` + +Defined in: [bee-js/src/types/index.ts:264](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L264) diff --git a/docs/api/interfaces/BalanceResponse.md b/docs/api/interfaces/BalanceResponse.md new file mode 100644 index 00000000..4afd1b1f --- /dev/null +++ b/docs/api/interfaces/BalanceResponse.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BalanceResponse + +# Interface: BalanceResponse + +Defined in: [bee-js/src/types/debug.ts:90](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L90) + +## Properties + +### balances + +> **balances**: [`PeerBalance`](PeerBalance.md)[] + +Defined in: [bee-js/src/types/debug.ts:91](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L91) diff --git a/docs/api/interfaces/BatchBucket.md b/docs/api/interfaces/BatchBucket.md new file mode 100644 index 00000000..a9ccee10 --- /dev/null +++ b/docs/api/interfaces/BatchBucket.md @@ -0,0 +1,25 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BatchBucket + +# Interface: BatchBucket + +Defined in: [bee-js/src/types/index.ts:510](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L510) + +## Properties + +### bucketID + +> **bucketID**: `number` + +Defined in: [bee-js/src/types/index.ts:511](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L511) + +*** + +### collisions + +> **collisions**: `number` + +Defined in: [bee-js/src/types/index.ts:512](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L512) diff --git a/docs/api/interfaces/BeeOptions.md b/docs/api/interfaces/BeeOptions.md new file mode 100644 index 00000000..5ebbb60a --- /dev/null +++ b/docs/api/interfaces/BeeOptions.md @@ -0,0 +1,127 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeOptions + +# Interface: BeeOptions + +Defined in: [bee-js/src/types/index.ts:53](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L53) + +## Extends + +- [`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md) + +## Properties + +### baseURL? + +> `optional` **baseURL**: `string` + +Defined in: [bee-js/src/types/index.ts:44](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L44) + +#### Inherited from + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md).[`baseURL`](../type-aliases/BeeRequestOptions.md#baseurl) + +*** + +### endlesslyRetry? + +> `optional` **endlesslyRetry**: `boolean` + +Defined in: [bee-js/src/types/index.ts:50](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L50) + +#### Inherited from + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md).[`endlesslyRetry`](../type-aliases/BeeRequestOptions.md#endlesslyretry) + +*** + +### headers? + +> `optional` **headers**: `Record`\<`string`, `string`\> + +Defined in: [bee-js/src/types/index.ts:46](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L46) + +#### Inherited from + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md).[`headers`](../type-aliases/BeeRequestOptions.md#headers) + +*** + +### httpAgent? + +> `optional` **httpAgent**: `unknown` + +Defined in: [bee-js/src/types/index.ts:48](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L48) + +#### Inherited from + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md).[`httpAgent`](../type-aliases/BeeRequestOptions.md#httpagent) + +*** + +### httpsAgent? + +> `optional` **httpsAgent**: `unknown` + +Defined in: [bee-js/src/types/index.ts:49](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L49) + +#### Inherited from + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md).[`httpsAgent`](../type-aliases/BeeRequestOptions.md#httpsagent) + +*** + +### network? + +> `optional` **network**: `"gnosis"` \| `"sepolia"` + +Defined in: [bee-js/src/types/index.ts:61](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L61) + +Default gnosis when unspecified. + +*** + +### onRequest()? + +> `optional` **onRequest**: (`request`) => `void` + +Defined in: [bee-js/src/types/index.ts:47](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L47) + +#### Parameters + +##### request + +[`BeeRequest`](BeeRequest.md) + +#### Returns + +`void` + +#### Inherited from + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md).[`onRequest`](../type-aliases/BeeRequestOptions.md#onrequest) + +*** + +### signer? + +> `optional` **signer**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`PrivateKey`](../classes/PrivateKey.md) + +Defined in: [bee-js/src/types/index.ts:57](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L57) + +Signer object or private key of the Signer in form of either hex string or Uint8Array that will be default signer for the instance. + +*** + +### timeout? + +> `optional` **timeout**: `number` + +Defined in: [bee-js/src/types/index.ts:45](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L45) + +#### Inherited from + +[`BeeRequestOptions`](../type-aliases/BeeRequestOptions.md).[`timeout`](../type-aliases/BeeRequestOptions.md#timeout) diff --git a/docs/api/interfaces/BeeRequest.md b/docs/api/interfaces/BeeRequest.md new file mode 100644 index 00000000..da765f3b --- /dev/null +++ b/docs/api/interfaces/BeeRequest.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeRequest + +# Interface: BeeRequest + +Defined in: [bee-js/src/types/index.ts:352](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L352) + +## Properties + +### headers? + +> `optional` **headers**: `Record`\<`string`, `string`\> + +Defined in: [bee-js/src/types/index.ts:355](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L355) + +*** + +### method + +> **method**: `string` + +Defined in: [bee-js/src/types/index.ts:354](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L354) + +*** + +### params? + +> `optional` **params**: `Record`\<`string`, `unknown`\> + +Defined in: [bee-js/src/types/index.ts:356](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L356) + +*** + +### url + +> **url**: `string` + +Defined in: [bee-js/src/types/index.ts:353](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L353) diff --git a/docs/api/interfaces/BeeResponse.md b/docs/api/interfaces/BeeResponse.md new file mode 100644 index 00000000..af76f0c8 --- /dev/null +++ b/docs/api/interfaces/BeeResponse.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeResponse + +# Interface: BeeResponse + +Defined in: [bee-js/src/types/index.ts:359](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L359) + +## Properties + +### headers + +> **headers**: `Record`\<`string`, `string`\> + +Defined in: [bee-js/src/types/index.ts:360](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L360) + +*** + +### request + +> **request**: [`BeeRequest`](BeeRequest.md) + +Defined in: [bee-js/src/types/index.ts:363](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L363) + +*** + +### status + +> **status**: `number` + +Defined in: [bee-js/src/types/index.ts:361](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L361) + +*** + +### statusText? + +> `optional` **statusText**: `string` + +Defined in: [bee-js/src/types/index.ts:362](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L362) diff --git a/docs/api/interfaces/BeeVersions.md b/docs/api/interfaces/BeeVersions.md new file mode 100644 index 00000000..3fb068ef --- /dev/null +++ b/docs/api/interfaces/BeeVersions.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeVersions + +# Interface: BeeVersions + +Defined in: [bee-js/src/types/debug.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L122) + +## Properties + +### beeApiVersion + +> **beeApiVersion**: `string` + +Defined in: [bee-js/src/types/debug.ts:126](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L126) + +*** + +### beeVersion + +> **beeVersion**: `string` + +Defined in: [bee-js/src/types/debug.ts:125](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L125) + +*** + +### supportedBeeApiVersion + +> **supportedBeeApiVersion**: `string` + +Defined in: [bee-js/src/types/debug.ts:124](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L124) + +*** + +### supportedBeeVersion + +> **supportedBeeVersion**: `string` + +Defined in: [bee-js/src/types/debug.ts:123](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L123) diff --git a/docs/api/interfaces/Bin.md b/docs/api/interfaces/Bin.md new file mode 100644 index 00000000..bd953813 --- /dev/null +++ b/docs/api/interfaces/Bin.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Bin + +# Interface: Bin + +Defined in: [bee-js/src/types/debug.ts:198](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L198) + +## Properties + +### connected + +> **connected**: `number` + +Defined in: [bee-js/src/types/debug.ts:200](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L200) + +*** + +### connectedPeers + +> **connectedPeers**: [`Peer`](Peer.md)[] + +Defined in: [bee-js/src/types/debug.ts:202](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L202) + +*** + +### disconnectedPeers + +> **disconnectedPeers**: [`Peer`](Peer.md)[] + +Defined in: [bee-js/src/types/debug.ts:201](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L201) + +*** + +### population + +> **population**: `number` + +Defined in: [bee-js/src/types/debug.ts:199](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L199) diff --git a/docs/api/interfaces/CashoutResult.md b/docs/api/interfaces/CashoutResult.md new file mode 100644 index 00000000..8bcab4dd --- /dev/null +++ b/docs/api/interfaces/CashoutResult.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / CashoutResult + +# Interface: CashoutResult + +Defined in: [bee-js/src/types/debug.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L51) + +## Properties + +### bounced + +> **bounced**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:54](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L54) + +*** + +### lastPayout + +> **lastPayout**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:53](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L53) + +*** + +### recipient + +> **recipient**: `string` + +Defined in: [bee-js/src/types/debug.ts:52](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L52) diff --git a/docs/api/interfaces/ChainState.md b/docs/api/interfaces/ChainState.md new file mode 100644 index 00000000..f279b56e --- /dev/null +++ b/docs/api/interfaces/ChainState.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / ChainState + +# Interface: ChainState + +Defined in: [bee-js/src/types/debug.ts:260](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L260) + +## Properties + +### block + +> **block**: `number` + +Defined in: [bee-js/src/types/debug.ts:262](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L262) + +*** + +### chainTip + +> **chainTip**: `number` + +Defined in: [bee-js/src/types/debug.ts:261](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L261) + +*** + +### currentPrice + +> **currentPrice**: `number` + +Defined in: [bee-js/src/types/debug.ts:264](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L264) + +*** + +### totalAmount + +> **totalAmount**: [`NumberString`](../type-aliases/NumberString.md) + +Defined in: [bee-js/src/types/debug.ts:263](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L263) diff --git a/docs/api/interfaces/Cheque.md b/docs/api/interfaces/Cheque.md new file mode 100644 index 00000000..d1747493 --- /dev/null +++ b/docs/api/interfaces/Cheque.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Cheque + +# Interface: Cheque + +Defined in: [bee-js/src/types/debug.ts:69](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L69) + +## Properties + +### beneficiary + +> **beneficiary**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/debug.ts:70](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L70) + +*** + +### chequebook + +> **chequebook**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/debug.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L71) + +*** + +### payout + +> **payout**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:72](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L72) diff --git a/docs/api/interfaces/ChequebookAddressResponse.md b/docs/api/interfaces/ChequebookAddressResponse.md new file mode 100644 index 00000000..65fe6310 --- /dev/null +++ b/docs/api/interfaces/ChequebookAddressResponse.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / ChequebookAddressResponse + +# Interface: ChequebookAddressResponse + +Defined in: [bee-js/src/types/debug.ts:30](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L30) + +## Properties + +### chequebookAddress + +> **chequebookAddress**: `string` + +Defined in: [bee-js/src/types/debug.ts:31](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L31) diff --git a/docs/api/interfaces/ChequebookBalanceResponse.md b/docs/api/interfaces/ChequebookBalanceResponse.md new file mode 100644 index 00000000..4475b0ea --- /dev/null +++ b/docs/api/interfaces/ChequebookBalanceResponse.md @@ -0,0 +1,25 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / ChequebookBalanceResponse + +# Interface: ChequebookBalanceResponse + +Defined in: [bee-js/src/types/debug.ts:34](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L34) + +## Properties + +### availableBalance + +> **availableBalance**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:36](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L36) + +*** + +### totalBalance + +> **totalBalance**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:35](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L35) diff --git a/docs/api/interfaces/CollectionEntry.md b/docs/api/interfaces/CollectionEntry.md new file mode 100644 index 00000000..7734918b --- /dev/null +++ b/docs/api/interfaces/CollectionEntry.md @@ -0,0 +1,43 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / CollectionEntry + +# Interface: CollectionEntry + +Defined in: [bee-js/src/types/index.ts:312](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L312) + +Object represents a file and some of its metadata in [[Directory]] object. + +## Properties + +### file? + +> `optional` **file**: `File` + +Defined in: [bee-js/src/types/index.ts:315](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L315) + +*** + +### fsPath? + +> `optional` **fsPath**: `string` + +Defined in: [bee-js/src/types/index.ts:316](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L316) + +*** + +### path + +> **path**: `string` + +Defined in: [bee-js/src/types/index.ts:313](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L313) + +*** + +### size + +> **size**: `number` + +Defined in: [bee-js/src/types/index.ts:314](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L314) diff --git a/docs/api/interfaces/CollectionUploadOptions.md b/docs/api/interfaces/CollectionUploadOptions.md new file mode 100644 index 00000000..e05342c3 --- /dev/null +++ b/docs/api/interfaces/CollectionUploadOptions.md @@ -0,0 +1,166 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / CollectionUploadOptions + +# Interface: CollectionUploadOptions + +Defined in: [bee-js/src/types/index.ts:218](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L218) + +## Extends + +- [`UploadOptions`](UploadOptions.md) + +## Properties + +### act? + +> `optional` **act**: `boolean` + +Defined in: [bee-js/src/types/index.ts:101](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L101) + +If set to true, an ACT will be created for the uploaded data. + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`act`](UploadOptions.md#act) + +*** + +### actHistoryAddress? + +> `optional` **actHistoryAddress**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:103](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L103) + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`actHistoryAddress`](UploadOptions.md#acthistoryaddress) + +*** + +### deferred? + +> `optional` **deferred**: `boolean` + +Defined in: [bee-js/src/types/index.ts:143](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L143) + +Determines if the uploaded data should be sent to the network immediately (eq. deferred=false) or in a deferred fashion (eq. deferred=true). + +With deferred style client uploads all the data to Bee node first and only then Bee node starts push the data to network itself. The progress of this upload can be tracked with tags. +With non-deferred style client uploads the data to Bee which immediately starts pushing the data to network. The request is only finished once all the data was pushed through the Bee node to the network. + +In future there will be move to the non-deferred style and even the support for deferred upload will be removed from Bee itself. + +#### Default + +```ts +true +``` + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`deferred`](UploadOptions.md#deferred) + +*** + +### encrypt? + +> `optional` **encrypt**: `boolean` + +Defined in: [bee-js/src/types/index.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L122) + +Will encrypt the uploaded data and return longer hash which also includes the decryption key. + +#### See + + - [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/develop/access-the-swarm/store-with-encryption) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - Reference + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`encrypt`](UploadOptions.md#encrypt) + +*** + +### errorDocument? + +> `optional` **errorDocument**: `string` + +Defined in: [bee-js/src/types/index.ts:233](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L233) + +Configure custom error document to be returned when a specified path can not be found in collection. + +#### See + + - [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### indexDocument? + +> `optional` **indexDocument**: `string` + +Defined in: [bee-js/src/types/index.ts:225](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L225) + +Default file to be returned when the root hash of collection is accessed. + +#### See + + - [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### pin? + +> `optional` **pin**: `boolean` + +Defined in: [bee-js/src/types/index.ts:113](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L113) + +Will pin the data locally in the Bee node as well. + +Locally pinned data is possible to reupload to network if it disappear. + +#### See + + - [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`pin`](UploadOptions.md#pin) + +*** + +### redundancyLevel? + +> `optional` **redundancyLevel**: [`RedundancyLevel`](../enumerations/RedundancyLevel.md) + +Defined in: [bee-js/src/types/index.ts:235](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L235) + +*** + +### tag? + +> `optional` **tag**: `number` + +Defined in: [bee-js/src/types/index.ts:131](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L131) + +Tags keep track of syncing the data with network. This option allows attach existing Tag UUID to the uploaded data. + +#### See + + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + +#### Link + +Tag + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`tag`](UploadOptions.md#tag) diff --git a/docs/api/interfaces/Data.md b/docs/api/interfaces/Data.md new file mode 100644 index 00000000..7e75edf6 --- /dev/null +++ b/docs/api/interfaces/Data.md @@ -0,0 +1,65 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Data + +# Interface: Data + +Defined in: [bee-js/src/types/index.ts:292](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L292) + +Helper interface that adds utility functions +to work more conveniently with bytes in normal +user scenarios. + +Concretely: text(), hex(), json() + +## Extends + +- `Uint8Array` + +## Indexable + +\[`index`: `number`\]: `number` + +## Methods + +### hex() + +> **hex**(): `string` + +Defined in: [bee-js/src/types/index.ts:301](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L301) + +Converts the binary data into hex-string. + +#### Returns + +`string` + +*** + +### json() + +> **json**(): `Record`\<`string`, `unknown`\> + +Defined in: [bee-js/src/types/index.ts:306](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L306) + +Converts the binary data into string which is then parsed into JSON. + +#### Returns + +`Record`\<`string`, `unknown`\> + +*** + +### text() + +> **text**(): `string` + +Defined in: [bee-js/src/types/index.ts:296](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L296) + +Converts the binary data using UTF-8 decoding into string. + +#### Returns + +`string` diff --git a/docs/api/interfaces/DebugStatus.md b/docs/api/interfaces/DebugStatus.md new file mode 100644 index 00000000..0da8cde6 --- /dev/null +++ b/docs/api/interfaces/DebugStatus.md @@ -0,0 +1,113 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / DebugStatus + +# Interface: DebugStatus + +Defined in: [bee-js/src/types/debug.ts:94](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L94) + +## Properties + +### batchCommitment + +> **batchCommitment**: `number` + +Defined in: [bee-js/src/types/debug.ts:104](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L104) + +*** + +### beeMode + +> **beeMode**: [`BeeModes`](../enumerations/BeeModes.md) + +Defined in: [bee-js/src/types/debug.ts:97](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L97) + +*** + +### committedDepth + +> **committedDepth**: `number` + +Defined in: [bee-js/src/types/debug.ts:107](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L107) + +*** + +### connectedPeers + +> **connectedPeers**: `number` + +Defined in: [bee-js/src/types/debug.ts:102](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L102) + +*** + +### isReachable + +> **isReachable**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:105](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L105) + +*** + +### lastSyncedBlock + +> **lastSyncedBlock**: `number` + +Defined in: [bee-js/src/types/debug.ts:106](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L106) + +*** + +### neighborhoodSize + +> **neighborhoodSize**: `number` + +Defined in: [bee-js/src/types/debug.ts:103](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L103) + +*** + +### overlay + +> **overlay**: `string` + +Defined in: [bee-js/src/types/debug.ts:95](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L95) + +*** + +### proximity + +> **proximity**: `number` + +Defined in: [bee-js/src/types/debug.ts:96](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L96) + +*** + +### pullsyncRate + +> **pullsyncRate**: `number` + +Defined in: [bee-js/src/types/debug.ts:100](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L100) + +*** + +### reserveSize + +> **reserveSize**: `number` + +Defined in: [bee-js/src/types/debug.ts:98](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L98) + +*** + +### reserveSizeWithinRadius + +> **reserveSizeWithinRadius**: `number` + +Defined in: [bee-js/src/types/debug.ts:99](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L99) + +*** + +### storageRadius + +> **storageRadius**: `number` + +Defined in: [bee-js/src/types/debug.ts:101](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L101) diff --git a/docs/api/interfaces/DownloadOptions.md b/docs/api/interfaces/DownloadOptions.md new file mode 100644 index 00000000..6d8d4560 --- /dev/null +++ b/docs/api/interfaces/DownloadOptions.md @@ -0,0 +1,63 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / DownloadOptions + +# Interface: DownloadOptions + +Defined in: [bee-js/src/types/index.ts:179](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L179) + +## Properties + +### actHistoryAddress? + +> `optional` **actHistoryAddress**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:195](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L195) + +*** + +### actPublisher? + +> `optional` **actPublisher**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`PublicKey`](../classes/PublicKey.md) + +Defined in: [bee-js/src/types/index.ts:193](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L193) + +*** + +### actTimestamp? + +> `optional` **actTimestamp**: `string` \| `number` + +Defined in: [bee-js/src/types/index.ts:197](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L197) + +*** + +### fallback? + +> `optional` **fallback**: `boolean` + +Defined in: [bee-js/src/types/index.ts:187](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L187) + +Specify if the retrieve strategies (chunk prefetching on redundant data) are used in a fallback cascade. The default is true. + +*** + +### redundancyStrategy? + +> `optional` **redundancyStrategy**: [`RedundancyStrategy`](../enumerations/RedundancyStrategy.md) + +Defined in: [bee-js/src/types/index.ts:183](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L183) + +Specify the retrieve strategy on redundant data. + +*** + +### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Defined in: [bee-js/src/types/index.ts:191](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L191) + +Specify the timeout for chunk retrieval. The default is 30 seconds. diff --git a/docs/api/interfaces/Envelope.md b/docs/api/interfaces/Envelope.md new file mode 100644 index 00000000..0d4b3a56 --- /dev/null +++ b/docs/api/interfaces/Envelope.md @@ -0,0 +1,45 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Envelope + +# Interface: Envelope + +Defined in: [bee-js/src/types/index.ts:572](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L572) + +## Extended by + +- [`EnvelopeWithBatchId`](EnvelopeWithBatchId.md) + +## Properties + +### index + +> **index**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:574](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L574) + +*** + +### issuer + +> **issuer**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:573](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L573) + +*** + +### signature + +> **signature**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:576](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L576) + +*** + +### timestamp + +> **timestamp**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:575](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L575) diff --git a/docs/api/interfaces/EnvelopeWithBatchId.md b/docs/api/interfaces/EnvelopeWithBatchId.md new file mode 100644 index 00000000..728389da --- /dev/null +++ b/docs/api/interfaces/EnvelopeWithBatchId.md @@ -0,0 +1,69 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / EnvelopeWithBatchId + +# Interface: EnvelopeWithBatchId + +Defined in: [bee-js/src/types/index.ts:579](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L579) + +## Extends + +- [`Envelope`](Envelope.md) + +## Properties + +### batchId + +> **batchId**: [`BatchId`](../classes/BatchId.md) + +Defined in: [bee-js/src/types/index.ts:580](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L580) + +*** + +### index + +> **index**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:574](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L574) + +#### Inherited from + +[`Envelope`](Envelope.md).[`index`](Envelope.md#index) + +*** + +### issuer + +> **issuer**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:573](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L573) + +#### Inherited from + +[`Envelope`](Envelope.md).[`issuer`](Envelope.md#issuer) + +*** + +### signature + +> **signature**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:576](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L576) + +#### Inherited from + +[`Envelope`](Envelope.md).[`signature`](Envelope.md#signature) + +*** + +### timestamp + +> **timestamp**: `Uint8Array` + +Defined in: [bee-js/src/types/index.ts:575](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L575) + +#### Inherited from + +[`Envelope`](Envelope.md).[`timestamp`](Envelope.md#timestamp) diff --git a/docs/api/interfaces/FeedReader.md b/docs/api/interfaces/FeedReader.md new file mode 100644 index 00000000..ebe264c8 --- /dev/null +++ b/docs/api/interfaces/FeedReader.md @@ -0,0 +1,93 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / FeedReader + +# Interface: FeedReader + +Defined in: [bee-js/src/types/index.ts:369](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L369) + +FeedReader is an interface for downloading feed updates + +## Extended by + +- [`FeedWriter`](FeedWriter.md) + +## Properties + +### owner + +> `readonly` **owner**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/index.ts:370](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L370) + +*** + +### topic + +> `readonly` **topic**: [`Topic`](../classes/Topic.md) + +Defined in: [bee-js/src/types/index.ts:371](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L371) + +## Methods + +### ~~download()~~ + +> **download**(`options?`): `Promise`\<`FeedPayloadResult`\> + +Defined in: [bee-js/src/types/index.ts:376](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L376) + +#### Parameters + +##### options? + +`FeedUpdateOptions` + +#### Returns + +`Promise`\<`FeedPayloadResult`\> + +#### Deprecated + +Use `downloadReference` or `downloadPayload` instead to disambiguate how the data should be interpreted. + +*** + +### downloadPayload() + +> **downloadPayload**(`options?`): `Promise`\<`FeedPayloadResult`\> + +Defined in: [bee-js/src/types/index.ts:386](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L386) + +Downloads the feed update (latest if no index is specified) and returns it as a payload. + +#### Parameters + +##### options? + +`FeedUpdateOptions` + +#### Returns + +`Promise`\<`FeedPayloadResult`\> + +*** + +### downloadReference() + +> **downloadReference**(`options?`): `Promise`\<`FeedReferenceResult`\> + +Defined in: [bee-js/src/types/index.ts:381](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L381) + +Downloads the feed update (latest if no index is specified) and returns it as a reference. + +#### Parameters + +##### options? + +`FeedUpdateOptions` + +#### Returns + +`Promise`\<`FeedReferenceResult`\> diff --git a/docs/api/interfaces/FeedWriter.md b/docs/api/interfaces/FeedWriter.md new file mode 100644 index 00000000..a164d2ba --- /dev/null +++ b/docs/api/interfaces/FeedWriter.md @@ -0,0 +1,205 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / FeedWriter + +# Interface: FeedWriter + +Defined in: [bee-js/src/types/index.ts:392](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L392) + +FeedWriter is an interface for updating feeds + +## Extends + +- [`FeedReader`](FeedReader.md) + +## Properties + +### owner + +> `readonly` **owner**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/index.ts:370](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L370) + +#### Inherited from + +[`FeedReader`](FeedReader.md).[`owner`](FeedReader.md#owner) + +*** + +### topic + +> `readonly` **topic**: [`Topic`](../classes/Topic.md) + +Defined in: [bee-js/src/types/index.ts:371](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L371) + +#### Inherited from + +[`FeedReader`](FeedReader.md).[`topic`](FeedReader.md#topic) + +## Methods + +### ~~download()~~ + +> **download**(`options?`): `Promise`\<`FeedPayloadResult`\> + +Defined in: [bee-js/src/types/index.ts:376](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L376) + +#### Parameters + +##### options? + +`FeedUpdateOptions` + +#### Returns + +`Promise`\<`FeedPayloadResult`\> + +#### Deprecated + +Use `downloadReference` or `downloadPayload` instead to disambiguate how the data should be interpreted. + +#### Inherited from + +[`FeedReader`](FeedReader.md).[`download`](FeedReader.md#download) + +*** + +### downloadPayload() + +> **downloadPayload**(`options?`): `Promise`\<`FeedPayloadResult`\> + +Defined in: [bee-js/src/types/index.ts:386](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L386) + +Downloads the feed update (latest if no index is specified) and returns it as a payload. + +#### Parameters + +##### options? + +`FeedUpdateOptions` + +#### Returns + +`Promise`\<`FeedPayloadResult`\> + +#### Inherited from + +[`FeedReader`](FeedReader.md).[`downloadPayload`](FeedReader.md#downloadpayload) + +*** + +### downloadReference() + +> **downloadReference**(`options?`): `Promise`\<`FeedReferenceResult`\> + +Defined in: [bee-js/src/types/index.ts:381](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L381) + +Downloads the feed update (latest if no index is specified) and returns it as a reference. + +#### Parameters + +##### options? + +`FeedUpdateOptions` + +#### Returns + +`Promise`\<`FeedReferenceResult`\> + +#### Inherited from + +[`FeedReader`](FeedReader.md).[`downloadReference`](FeedReader.md#downloadreference) + +*** + +### ~~upload()~~ + +> **upload**(`postageBatchId`, `reference`, `options?`): `Promise`\<[`UploadResult`](UploadResult.md)\> + +Defined in: [bee-js/src/types/index.ts:404](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L404) + +Upload a new feed update + +#### Parameters + +##### postageBatchId + +Postage BatchId to be used to upload the data with + +`string` | [`BatchId`](../classes/BatchId.md) + +##### reference + +The reference to be stored in the new update + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](../classes/Reference.md) + +##### options? + +`FeedUploadOptions` + +Additional options like `at` + +#### Returns + +`Promise`\<[`UploadResult`](UploadResult.md)\> + +UpdateResult that points at Single Owner Chunk that contains the new update and pointer to the updated chunk reference. + +#### Deprecated + +Use `uploadReference` or `uploadPayload` instead to disambiguate how the data should be interpreted. + +*** + +### uploadPayload() + +> **uploadPayload**(`postageBatchId`, `payload`, `options?`): `Promise`\<[`UploadResult`](UploadResult.md)\> + +Defined in: [bee-js/src/types/index.ts:416](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L416) + +#### Parameters + +##### postageBatchId + +`string` | [`BatchId`](../classes/BatchId.md) + +##### payload + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +##### options? + +`FeedUploadOptions` + +#### Returns + +`Promise`\<[`UploadResult`](UploadResult.md)\> + +*** + +### uploadReference() + +> **uploadReference**(`postageBatchId`, `reference`, `options?`): `Promise`\<[`UploadResult`](UploadResult.md)\> + +Defined in: [bee-js/src/types/index.ts:410](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L410) + +#### Parameters + +##### postageBatchId + +`string` | [`BatchId`](../classes/BatchId.md) + +##### reference + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Reference`](../classes/Reference.md) + +##### options? + +`FeedUploadOptions` + +#### Returns + +`Promise`\<[`UploadResult`](UploadResult.md)\> diff --git a/docs/api/interfaces/FileData.md b/docs/api/interfaces/FileData.md new file mode 100644 index 00000000..889add0c --- /dev/null +++ b/docs/api/interfaces/FileData.md @@ -0,0 +1,63 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / FileData + +# Interface: FileData\ + +Defined in: [bee-js/src/types/index.ts:273](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L273) + +## Extends + +- [`FileHeaders`](FileHeaders.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### contentType? + +> `optional` **contentType**: `string` + +Defined in: [bee-js/src/types/index.ts:270](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L270) + +#### Inherited from + +[`FileHeaders`](FileHeaders.md).[`contentType`](FileHeaders.md#contenttype) + +*** + +### data + +> **data**: `T` + +Defined in: [bee-js/src/types/index.ts:274](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L274) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [bee-js/src/types/index.ts:268](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L268) + +#### Inherited from + +[`FileHeaders`](FileHeaders.md).[`name`](FileHeaders.md#name) + +*** + +### tagUid? + +> `optional` **tagUid**: `number` + +Defined in: [bee-js/src/types/index.ts:269](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L269) + +#### Inherited from + +[`FileHeaders`](FileHeaders.md).[`tagUid`](FileHeaders.md#taguid) diff --git a/docs/api/interfaces/FileHeaders.md b/docs/api/interfaces/FileHeaders.md new file mode 100644 index 00000000..fb29d7fc --- /dev/null +++ b/docs/api/interfaces/FileHeaders.md @@ -0,0 +1,37 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / FileHeaders + +# Interface: FileHeaders + +Defined in: [bee-js/src/types/index.ts:267](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L267) + +## Extended by + +- [`FileData`](FileData.md) + +## Properties + +### contentType? + +> `optional` **contentType**: `string` + +Defined in: [bee-js/src/types/index.ts:270](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L270) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [bee-js/src/types/index.ts:268](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L268) + +*** + +### tagUid? + +> `optional` **tagUid**: `number` + +Defined in: [bee-js/src/types/index.ts:269](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L269) diff --git a/docs/api/interfaces/FileUploadOptions.md b/docs/api/interfaces/FileUploadOptions.md new file mode 100644 index 00000000..16750f7b --- /dev/null +++ b/docs/api/interfaces/FileUploadOptions.md @@ -0,0 +1,164 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / FileUploadOptions + +# Interface: FileUploadOptions + +Defined in: [bee-js/src/types/index.ts:200](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L200) + +## Extends + +- [`UploadOptions`](UploadOptions.md) + +## Properties + +### act? + +> `optional` **act**: `boolean` + +Defined in: [bee-js/src/types/index.ts:101](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L101) + +If set to true, an ACT will be created for the uploaded data. + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`act`](UploadOptions.md#act) + +*** + +### actHistoryAddress? + +> `optional` **actHistoryAddress**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:103](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L103) + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`actHistoryAddress`](UploadOptions.md#acthistoryaddress) + +*** + +### contentType? + +> `optional` **contentType**: `string` + +Defined in: [bee-js/src/types/index.ts:213](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L213) + +Specifies given Content-Type so when loaded in browser the file is correctly represented. + +#### See + +[Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### deferred? + +> `optional` **deferred**: `boolean` + +Defined in: [bee-js/src/types/index.ts:143](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L143) + +Determines if the uploaded data should be sent to the network immediately (eq. deferred=false) or in a deferred fashion (eq. deferred=true). + +With deferred style client uploads all the data to Bee node first and only then Bee node starts push the data to network itself. The progress of this upload can be tracked with tags. +With non-deferred style client uploads the data to Bee which immediately starts pushing the data to network. The request is only finished once all the data was pushed through the Bee node to the network. + +In future there will be move to the non-deferred style and even the support for deferred upload will be removed from Bee itself. + +#### Default + +```ts +true +``` + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`deferred`](UploadOptions.md#deferred) + +*** + +### encrypt? + +> `optional` **encrypt**: `boolean` + +Defined in: [bee-js/src/types/index.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L122) + +Will encrypt the uploaded data and return longer hash which also includes the decryption key. + +#### See + + - [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/develop/access-the-swarm/store-with-encryption) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - Reference + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`encrypt`](UploadOptions.md#encrypt) + +*** + +### pin? + +> `optional` **pin**: `boolean` + +Defined in: [bee-js/src/types/index.ts:113](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L113) + +Will pin the data locally in the Bee node as well. + +Locally pinned data is possible to reupload to network if it disappear. + +#### See + + - [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`pin`](UploadOptions.md#pin) + +*** + +### redundancyLevel? + +> `optional` **redundancyLevel**: [`RedundancyLevel`](../enumerations/RedundancyLevel.md) + +Defined in: [bee-js/src/types/index.ts:215](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L215) + +*** + +### size? + +> `optional` **size**: `number` + +Defined in: [bee-js/src/types/index.ts:206](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L206) + +Specifies Content-Length for the given data. It is required when uploading with Readable. + +#### See + +[Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### tag? + +> `optional` **tag**: `number` + +Defined in: [bee-js/src/types/index.ts:131](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L131) + +Tags keep track of syncing the data with network. This option allows attach existing Tag UUID to the uploaded data. + +#### See + + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + +#### Link + +Tag + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`tag`](UploadOptions.md#tag) diff --git a/docs/api/interfaces/GetGranteesResult.md b/docs/api/interfaces/GetGranteesResult.md new file mode 100644 index 00000000..5d38b6a9 --- /dev/null +++ b/docs/api/interfaces/GetGranteesResult.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / GetGranteesResult + +# Interface: GetGranteesResult + +Defined in: [bee-js/src/types/index.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L71) + +## Properties + +### grantees + +> **grantees**: [`PublicKey`](../classes/PublicKey.md)[] + +Defined in: [bee-js/src/types/index.ts:74](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L74) + +*** + +### status + +> **status**: `number` + +Defined in: [bee-js/src/types/index.ts:72](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L72) + +*** + +### statusText + +> **statusText**: `string` + +Defined in: [bee-js/src/types/index.ts:73](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L73) diff --git a/docs/api/interfaces/GlobalPostageBatch.md b/docs/api/interfaces/GlobalPostageBatch.md new file mode 100644 index 00000000..af5f8dcc --- /dev/null +++ b/docs/api/interfaces/GlobalPostageBatch.md @@ -0,0 +1,73 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / GlobalPostageBatch + +# Interface: GlobalPostageBatch + +Defined in: [bee-js/src/types/index.ts:455](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L455) + +## Properties + +### batchID + +> **batchID**: [`BatchId`](../classes/BatchId.md) + +Defined in: [bee-js/src/types/index.ts:456](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L456) + +*** + +### batchTTL + +> **batchTTL**: `number` + +Defined in: [bee-js/src/types/index.ts:463](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L463) + +*** + +### bucketDepth + +> **bucketDepth**: `number` + +Defined in: [bee-js/src/types/index.ts:461](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L461) + +*** + +### depth + +> **depth**: `number` + +Defined in: [bee-js/src/types/index.ts:460](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L460) + +*** + +### immutable + +> **immutable**: `boolean` + +Defined in: [bee-js/src/types/index.ts:462](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L462) + +*** + +### owner + +> **owner**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/index.ts:459](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L459) + +*** + +### start + +> **start**: `number` + +Defined in: [bee-js/src/types/index.ts:458](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L458) + +*** + +### value + +> **value**: [`NumberString`](../type-aliases/NumberString.md) + +Defined in: [bee-js/src/types/index.ts:457](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L457) diff --git a/docs/api/interfaces/GranteesResult.md b/docs/api/interfaces/GranteesResult.md new file mode 100644 index 00000000..c233b0c5 --- /dev/null +++ b/docs/api/interfaces/GranteesResult.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / GranteesResult + +# Interface: GranteesResult + +Defined in: [bee-js/src/types/index.ts:64](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L64) + +## Properties + +### historyref + +> **historyref**: [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:68](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L68) + +*** + +### ref + +> **ref**: [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L67) + +*** + +### status + +> **status**: `number` + +Defined in: [bee-js/src/types/index.ts:65](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L65) + +*** + +### statusText + +> **statusText**: `string` + +Defined in: [bee-js/src/types/index.ts:66](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L66) diff --git a/docs/api/interfaces/GsocMessageHandler.md b/docs/api/interfaces/GsocMessageHandler.md new file mode 100644 index 00000000..64e9a020 --- /dev/null +++ b/docs/api/interfaces/GsocMessageHandler.md @@ -0,0 +1,53 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / GsocMessageHandler + +# Interface: GsocMessageHandler + +Defined in: [bee-js/src/types/index.ts:339](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L339) + +## Properties + +### onError() + +> **onError**: (`error`, `subscription`) => `void` + +Defined in: [bee-js/src/types/index.ts:341](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L341) + +#### Parameters + +##### error + +[`BeeError`](../classes/BeeError.md) + +##### subscription + +[`GsocSubscription`](GsocSubscription.md) + +#### Returns + +`void` + +*** + +### onMessage() + +> **onMessage**: (`message`, `subscription`) => `void` + +Defined in: [bee-js/src/types/index.ts:340](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L340) + +#### Parameters + +##### message + +[`Bytes`](../classes/Bytes.md) + +##### subscription + +[`GsocSubscription`](GsocSubscription.md) + +#### Returns + +`void` diff --git a/docs/api/interfaces/GsocSubscription.md b/docs/api/interfaces/GsocSubscription.md new file mode 100644 index 00000000..7d62d953 --- /dev/null +++ b/docs/api/interfaces/GsocSubscription.md @@ -0,0 +1,29 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / GsocSubscription + +# Interface: GsocSubscription + +Defined in: [bee-js/src/types/index.ts:334](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L334) + +## Properties + +### address + +> `readonly` **address**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/index.ts:335](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L335) + +*** + +### cancel() + +> **cancel**: () => `void` + +Defined in: [bee-js/src/types/index.ts:336](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L336) + +#### Returns + +`void` diff --git a/docs/api/interfaces/Health.md b/docs/api/interfaces/Health.md new file mode 100644 index 00000000..0f55c78b --- /dev/null +++ b/docs/api/interfaces/Health.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Health + +# Interface: Health + +Defined in: [bee-js/src/types/debug.ts:110](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L110) + +## Properties + +### apiVersion + +> **apiVersion**: `string` + +Defined in: [bee-js/src/types/debug.ts:113](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L113) + +*** + +### status + +> **status**: `"ok"` + +Defined in: [bee-js/src/types/debug.ts:111](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L111) + +*** + +### version + +> **version**: `string` + +Defined in: [bee-js/src/types/debug.ts:112](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L112) diff --git a/docs/api/interfaces/LastCashoutActionResponse.md b/docs/api/interfaces/LastCashoutActionResponse.md new file mode 100644 index 00000000..331dd806 --- /dev/null +++ b/docs/api/interfaces/LastCashoutActionResponse.md @@ -0,0 +1,49 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / LastCashoutActionResponse + +# Interface: LastCashoutActionResponse + +Defined in: [bee-js/src/types/debug.ts:57](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L57) + +## Properties + +### lastCashedCheque + +> **lastCashedCheque**: `null` \| [`Cheque`](Cheque.md) + +Defined in: [bee-js/src/types/debug.ts:61](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L61) + +*** + +### peer + +> **peer**: `string` + +Defined in: [bee-js/src/types/debug.ts:58](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L58) + +*** + +### result + +> **result**: `null` \| [`CashoutResult`](CashoutResult.md) + +Defined in: [bee-js/src/types/debug.ts:62](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L62) + +*** + +### transactionHash + +> **transactionHash**: `null` \| `string` + +Defined in: [bee-js/src/types/debug.ts:60](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L60) + +*** + +### uncashedAmount + +> **uncashedAmount**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:59](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L59) diff --git a/docs/api/interfaces/LastChequesForPeerResponse.md b/docs/api/interfaces/LastChequesForPeerResponse.md new file mode 100644 index 00000000..c5406bee --- /dev/null +++ b/docs/api/interfaces/LastChequesForPeerResponse.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / LastChequesForPeerResponse + +# Interface: LastChequesForPeerResponse + +Defined in: [bee-js/src/types/debug.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L75) + +## Properties + +### lastreceived + +> **lastreceived**: `null` \| [`Cheque`](Cheque.md) + +Defined in: [bee-js/src/types/debug.ts:77](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L77) + +*** + +### lastsent + +> **lastsent**: `null` \| [`Cheque`](Cheque.md) + +Defined in: [bee-js/src/types/debug.ts:78](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L78) + +*** + +### peer + +> **peer**: `string` + +Defined in: [bee-js/src/types/debug.ts:76](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L76) diff --git a/docs/api/interfaces/LastChequesResponse.md b/docs/api/interfaces/LastChequesResponse.md new file mode 100644 index 00000000..4f924fbf --- /dev/null +++ b/docs/api/interfaces/LastChequesResponse.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / LastChequesResponse + +# Interface: LastChequesResponse + +Defined in: [bee-js/src/types/debug.ts:81](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L81) + +## Properties + +### lastcheques + +> **lastcheques**: [`LastChequesForPeerResponse`](LastChequesForPeerResponse.md)[] + +Defined in: [bee-js/src/types/debug.ts:82](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L82) diff --git a/docs/api/interfaces/NodeAddresses.md b/docs/api/interfaces/NodeAddresses.md new file mode 100644 index 00000000..615c5be9 --- /dev/null +++ b/docs/api/interfaces/NodeAddresses.md @@ -0,0 +1,49 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NodeAddresses + +# Interface: NodeAddresses + +Defined in: [bee-js/src/types/debug.ts:17](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L17) + +## Properties + +### ethereum + +> **ethereum**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/debug.ts:20](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L20) + +*** + +### overlay + +> **overlay**: [`PeerAddress`](../classes/PeerAddress.md) + +Defined in: [bee-js/src/types/debug.ts:18](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L18) + +*** + +### pssPublicKey + +> **pssPublicKey**: [`PublicKey`](../classes/PublicKey.md) + +Defined in: [bee-js/src/types/debug.ts:22](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L22) + +*** + +### publicKey + +> **publicKey**: [`PublicKey`](../classes/PublicKey.md) + +Defined in: [bee-js/src/types/debug.ts:21](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L21) + +*** + +### underlay + +> **underlay**: `string`[] + +Defined in: [bee-js/src/types/debug.ts:19](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L19) diff --git a/docs/api/interfaces/NodeInfo.md b/docs/api/interfaces/NodeInfo.md new file mode 100644 index 00000000..c254b9fe --- /dev/null +++ b/docs/api/interfaces/NodeInfo.md @@ -0,0 +1,49 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NodeInfo + +# Interface: NodeInfo + +Defined in: [bee-js/src/types/debug.ts:172](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L172) + +Information about Bee node and its configuration + +## Properties + +### beeMode + +> **beeMode**: [`BeeModes`](../enumerations/BeeModes.md) + +Defined in: [bee-js/src/types/debug.ts:176](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L176) + +Indicates in what mode Bee is running. + +*** + +### chequebookEnabled + +> **chequebookEnabled**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:183](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L183) + +Indicates whether the Bee node has its own deployed chequebook. + +#### See + +[Bee docs - Chequebook](https://docs.ethswarm.org/docs/references/glossary/#cheques--chequebook) + +*** + +### swapEnabled + +> **swapEnabled**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:190](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L190) + +Indicates whether SWAP is enabled for the Bee node. + +#### See + +[Bee docs - SWAP](https://docs.ethswarm.org/docs/references/glossary/#swap) diff --git a/docs/api/interfaces/Peer.md b/docs/api/interfaces/Peer.md new file mode 100644 index 00000000..01dfc2fd --- /dev/null +++ b/docs/api/interfaces/Peer.md @@ -0,0 +1,25 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Peer + +# Interface: Peer + +Defined in: [bee-js/src/types/debug.ts:25](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L25) + +## Properties + +### address + +> **address**: `string` + +Defined in: [bee-js/src/types/debug.ts:26](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L26) + +*** + +### fullNode? + +> `optional` **fullNode**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:27](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L27) diff --git a/docs/api/interfaces/PeerBalance.md b/docs/api/interfaces/PeerBalance.md new file mode 100644 index 00000000..7642ac13 --- /dev/null +++ b/docs/api/interfaces/PeerBalance.md @@ -0,0 +1,25 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PeerBalance + +# Interface: PeerBalance + +Defined in: [bee-js/src/types/debug.ts:85](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L85) + +## Properties + +### balance + +> **balance**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:87](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L87) + +*** + +### peer + +> **peer**: `string` + +Defined in: [bee-js/src/types/debug.ts:86](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L86) diff --git a/docs/api/interfaces/Pin.md b/docs/api/interfaces/Pin.md new file mode 100644 index 00000000..d602a77d --- /dev/null +++ b/docs/api/interfaces/Pin.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Pin + +# Interface: Pin + +Defined in: [bee-js/src/types/index.ts:277](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L277) + +## Properties + +### reference + +> **reference**: [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:278](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L278) diff --git a/docs/api/interfaces/PingResponse.md b/docs/api/interfaces/PingResponse.md new file mode 100644 index 00000000..813c4084 --- /dev/null +++ b/docs/api/interfaces/PingResponse.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PingResponse + +# Interface: PingResponse + +Defined in: [bee-js/src/types/debug.ts:250](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L250) + +## Properties + +### rtt + +> **rtt**: `string` + +Defined in: [bee-js/src/types/debug.ts:251](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L251) diff --git a/docs/api/interfaces/PostageBatch.md b/docs/api/interfaces/PostageBatch.md new file mode 100644 index 00000000..d215200a --- /dev/null +++ b/docs/api/interfaces/PostageBatch.md @@ -0,0 +1,148 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PostageBatch + +# Interface: PostageBatch + +Defined in: [bee-js/src/types/index.ts:466](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L466) + +## Properties + +### amount + +> **amount**: [`NumberString`](../type-aliases/NumberString.md) + +Defined in: [bee-js/src/types/index.ts:480](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L480) + +*** + +### batchID + +> **batchID**: [`BatchId`](../classes/BatchId.md) + +Defined in: [bee-js/src/types/index.ts:467](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L467) + +*** + +### blockNumber + +> **blockNumber**: `number` + +Defined in: [bee-js/src/types/index.ts:482](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L482) + +*** + +### bucketDepth + +> **bucketDepth**: `number` + +Defined in: [bee-js/src/types/index.ts:481](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L481) + +*** + +### depth + +> **depth**: `number` + +Defined in: [bee-js/src/types/index.ts:479](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L479) + +*** + +### duration + +> **duration**: [`Duration`](../classes/Duration.md) + +Defined in: [bee-js/src/types/index.ts:487](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L487) + +Estimated time until the batch expires + +*** + +### immutableFlag + +> **immutableFlag**: `boolean` + +Defined in: [bee-js/src/types/index.ts:483](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L483) + +*** + +### label + +> **label**: `string` + +Defined in: [bee-js/src/types/index.ts:478](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L478) + +*** + +### remainingSize + +> **remainingSize**: [`Size`](../classes/Size.md) + +Defined in: [bee-js/src/types/index.ts:503](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L503) + +Estimated remaining size + +*** + +### size + +> **size**: [`Size`](../classes/Size.md) + +Defined in: [bee-js/src/types/index.ts:499](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L499) + +Effective size + +*** + +### theoreticalSize + +> **theoreticalSize**: [`Size`](../classes/Size.md) + +Defined in: [bee-js/src/types/index.ts:507](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L507) + +Theoretical size in bytes + +*** + +### usable + +> **usable**: `boolean` + +Defined in: [bee-js/src/types/index.ts:477](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L477) + +*** + +### usage + +> **usage**: `number` + +Defined in: [bee-js/src/types/index.ts:491](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L491) + +A floating point number from 0 to 1, where 0 is no usage, 1 is full usage. + +*** + +### usageText + +> **usageText**: `string` + +Defined in: [bee-js/src/types/index.ts:495](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L495) + +Human readable usage text, like "50%" or "100%", no fractions + +*** + +### utilization + +> **utilization**: `number` + +Defined in: [bee-js/src/types/index.ts:476](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L476) + +Represents how much of the batch is used up. + +Max utilization = `2 ** (depth - bucketDepth)` + +Since the smallest depth is 17, and one batch has 65,536 buckets, and one chunk is 4,096 bytes, +the 512MB theoretical max size for the smallest stamp comes from `2 * 65536 * 4096 = 512MB` diff --git a/docs/api/interfaces/PostageBatchBuckets.md b/docs/api/interfaces/PostageBatchBuckets.md new file mode 100644 index 00000000..262c7f19 --- /dev/null +++ b/docs/api/interfaces/PostageBatchBuckets.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PostageBatchBuckets + +# Interface: PostageBatchBuckets + +Defined in: [bee-js/src/types/index.ts:515](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L515) + +## Properties + +### bucketDepth + +> **bucketDepth**: `number` + +Defined in: [bee-js/src/types/index.ts:517](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L517) + +*** + +### buckets + +> **buckets**: [`BatchBucket`](BatchBucket.md)[] + +Defined in: [bee-js/src/types/index.ts:519](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L519) + +*** + +### bucketUpperBound + +> **bucketUpperBound**: `number` + +Defined in: [bee-js/src/types/index.ts:518](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L518) + +*** + +### depth + +> **depth**: `number` + +Defined in: [bee-js/src/types/index.ts:516](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L516) diff --git a/docs/api/interfaces/PostageBatchOptions.md b/docs/api/interfaces/PostageBatchOptions.md new file mode 100644 index 00000000..e5b350bc --- /dev/null +++ b/docs/api/interfaces/PostageBatchOptions.md @@ -0,0 +1,73 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PostageBatchOptions + +# Interface: PostageBatchOptions + +Defined in: [bee-js/src/types/index.ts:537](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L537) + +Options for creation of postage batch + +## Properties + +### gasPrice? + +> `optional` **gasPrice**: `string` \| `bigint` \| [`NumberString`](../type-aliases/NumberString.md) + +Defined in: [bee-js/src/types/index.ts:546](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L546) + +Sets gas price in Wei for the transaction that creates the postage batch + +*** + +### immutableFlag? + +> `optional` **immutableFlag**: `boolean` + +Defined in: [bee-js/src/types/index.ts:551](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L551) + +Controls whether data can be overwritten that was uploaded with this postage batch. + +*** + +### label? + +> `optional` **label**: `string` + +Defined in: [bee-js/src/types/index.ts:541](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L541) + +Sets label for the postage batch + +*** + +### waitForUsable? + +> `optional` **waitForUsable**: `boolean` + +Defined in: [bee-js/src/types/index.ts:563](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L563) + +The returned Promise will await until the purchased Postage Batch is usable. +In other word, it has to have enough block confirmations that Bee pronounce it usable. +When turned on, this significantly prolongs the creation of postage batch! + +If you plan to use the stamp right away for some action with Bee (like uploading using this stamp) it is +highly recommended to use this option, otherwise you might get errors "stamp not usable" from Bee. + +#### Default + +```ts +true +``` + +*** + +### waitForUsableTimeout? + +> `optional` **waitForUsableTimeout**: `number` + +Defined in: [bee-js/src/types/index.ts:569](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L569) + +When waiting for the postage stamp to become usable, this specify the timeout for the waiting. +Default: 120s diff --git a/docs/api/interfaces/PssMessageHandler.md b/docs/api/interfaces/PssMessageHandler.md new file mode 100644 index 00000000..14d7cee4 --- /dev/null +++ b/docs/api/interfaces/PssMessageHandler.md @@ -0,0 +1,53 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PssMessageHandler + +# Interface: PssMessageHandler + +Defined in: [bee-js/src/types/index.ts:329](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L329) + +## Properties + +### onError() + +> **onError**: (`error`, `subscription`) => `void` + +Defined in: [bee-js/src/types/index.ts:331](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L331) + +#### Parameters + +##### error + +[`BeeError`](../classes/BeeError.md) + +##### subscription + +[`PssSubscription`](PssSubscription.md) + +#### Returns + +`void` + +*** + +### onMessage() + +> **onMessage**: (`message`, `subscription`) => `void` + +Defined in: [bee-js/src/types/index.ts:330](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L330) + +#### Parameters + +##### message + +[`Bytes`](../classes/Bytes.md) + +##### subscription + +[`PssSubscription`](PssSubscription.md) + +#### Returns + +`void` diff --git a/docs/api/interfaces/PssSubscription.md b/docs/api/interfaces/PssSubscription.md new file mode 100644 index 00000000..3f730f2c --- /dev/null +++ b/docs/api/interfaces/PssSubscription.md @@ -0,0 +1,29 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PssSubscription + +# Interface: PssSubscription + +Defined in: [bee-js/src/types/index.ts:324](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L324) + +## Properties + +### cancel() + +> **cancel**: () => `void` + +Defined in: [bee-js/src/types/index.ts:326](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L326) + +#### Returns + +`void` + +*** + +### topic + +> `readonly` **topic**: [`Topic`](../classes/Topic.md) + +Defined in: [bee-js/src/types/index.ts:325](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L325) diff --git a/docs/api/interfaces/Readiness.md b/docs/api/interfaces/Readiness.md new file mode 100644 index 00000000..024675cc --- /dev/null +++ b/docs/api/interfaces/Readiness.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Readiness + +# Interface: Readiness + +Defined in: [bee-js/src/types/debug.ts:116](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L116) + +## Properties + +### apiVersion + +> **apiVersion**: `string` + +Defined in: [bee-js/src/types/debug.ts:119](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L119) + +*** + +### status + +> **status**: `string` + +Defined in: [bee-js/src/types/debug.ts:117](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L117) + +*** + +### version + +> **version**: `string` + +Defined in: [bee-js/src/types/debug.ts:118](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L118) diff --git a/docs/api/interfaces/RedistributionState.md b/docs/api/interfaces/RedistributionState.md new file mode 100644 index 00000000..86215323 --- /dev/null +++ b/docs/api/interfaces/RedistributionState.md @@ -0,0 +1,129 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / RedistributionState + +# Interface: RedistributionState + +Defined in: [bee-js/src/types/debug.ts:151](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L151) + +## Properties + +### block + +> **block**: `number` + +Defined in: [bee-js/src/types/debug.ts:163](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L163) + +*** + +### fees + +> **fees**: [`DAI`](../classes/DAI.md) + +Defined in: [bee-js/src/types/debug.ts:165](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L165) + +*** + +### hasSufficientFunds + +> **hasSufficientFunds**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:153](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L153) + +*** + +### isFrozen + +> **isFrozen**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:154](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L154) + +*** + +### isFullySynced + +> **isFullySynced**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:155](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L155) + +*** + +### isHealthy + +> **isHealthy**: `boolean` + +Defined in: [bee-js/src/types/debug.ts:166](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L166) + +*** + +### lastFrozenRound + +> **lastFrozenRound**: `number` + +Defined in: [bee-js/src/types/debug.ts:160](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L160) + +*** + +### lastPlayedRound + +> **lastPlayedRound**: `number` + +Defined in: [bee-js/src/types/debug.ts:159](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L159) + +*** + +### lastSampleDurationSeconds + +> **lastSampleDurationSeconds**: `number` + +Defined in: [bee-js/src/types/debug.ts:162](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L162) + +*** + +### lastSelectedRound + +> **lastSelectedRound**: `number` + +Defined in: [bee-js/src/types/debug.ts:161](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L161) + +*** + +### lastWonRound + +> **lastWonRound**: `number` + +Defined in: [bee-js/src/types/debug.ts:158](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L158) + +*** + +### minimumGasFunds + +> **minimumGasFunds**: [`DAI`](../classes/DAI.md) + +Defined in: [bee-js/src/types/debug.ts:152](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L152) + +*** + +### phase + +> **phase**: `string` + +Defined in: [bee-js/src/types/debug.ts:156](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L156) + +*** + +### reward + +> **reward**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:164](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L164) + +*** + +### round + +> **round**: `number` + +Defined in: [bee-js/src/types/debug.ts:157](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L157) diff --git a/docs/api/interfaces/RedundantUploadOptions.md b/docs/api/interfaces/RedundantUploadOptions.md new file mode 100644 index 00000000..4f36dca6 --- /dev/null +++ b/docs/api/interfaces/RedundantUploadOptions.md @@ -0,0 +1,136 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / RedundantUploadOptions + +# Interface: RedundantUploadOptions + +Defined in: [bee-js/src/types/index.ts:158](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L158) + +## Extends + +- [`UploadOptions`](UploadOptions.md) + +## Properties + +### act? + +> `optional` **act**: `boolean` + +Defined in: [bee-js/src/types/index.ts:101](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L101) + +If set to true, an ACT will be created for the uploaded data. + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`act`](UploadOptions.md#act) + +*** + +### actHistoryAddress? + +> `optional` **actHistoryAddress**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:103](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L103) + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`actHistoryAddress`](UploadOptions.md#acthistoryaddress) + +*** + +### deferred? + +> `optional` **deferred**: `boolean` + +Defined in: [bee-js/src/types/index.ts:143](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L143) + +Determines if the uploaded data should be sent to the network immediately (eq. deferred=false) or in a deferred fashion (eq. deferred=true). + +With deferred style client uploads all the data to Bee node first and only then Bee node starts push the data to network itself. The progress of this upload can be tracked with tags. +With non-deferred style client uploads the data to Bee which immediately starts pushing the data to network. The request is only finished once all the data was pushed through the Bee node to the network. + +In future there will be move to the non-deferred style and even the support for deferred upload will be removed from Bee itself. + +#### Default + +```ts +true +``` + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`deferred`](UploadOptions.md#deferred) + +*** + +### encrypt? + +> `optional` **encrypt**: `boolean` + +Defined in: [bee-js/src/types/index.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L122) + +Will encrypt the uploaded data and return longer hash which also includes the decryption key. + +#### See + + - [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/develop/access-the-swarm/store-with-encryption) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - Reference + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`encrypt`](UploadOptions.md#encrypt) + +*** + +### pin? + +> `optional` **pin**: `boolean` + +Defined in: [bee-js/src/types/index.ts:113](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L113) + +Will pin the data locally in the Bee node as well. + +Locally pinned data is possible to reupload to network if it disappear. + +#### See + + - [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`pin`](UploadOptions.md#pin) + +*** + +### redundancyLevel? + +> `optional` **redundancyLevel**: [`RedundancyLevel`](../enumerations/RedundancyLevel.md) + +Defined in: [bee-js/src/types/index.ts:159](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L159) + +*** + +### tag? + +> `optional` **tag**: `number` + +Defined in: [bee-js/src/types/index.ts:131](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L131) + +Tags keep track of syncing the data with network. This option allows attach existing Tag UUID to the uploaded data. + +#### See + + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + +#### Link + +Tag + +#### Inherited from + +[`UploadOptions`](UploadOptions.md).[`tag`](UploadOptions.md#tag) diff --git a/docs/api/interfaces/ReferenceInformation.md b/docs/api/interfaces/ReferenceInformation.md new file mode 100644 index 00000000..3351f1f5 --- /dev/null +++ b/docs/api/interfaces/ReferenceInformation.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / ReferenceInformation + +# Interface: ReferenceInformation + +Defined in: [bee-js/src/types/index.ts:281](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L281) + +## Properties + +### contentLength + +> **contentLength**: `number` + +Defined in: [bee-js/src/types/index.ts:282](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L282) diff --git a/docs/api/interfaces/ReferenceResponse.md b/docs/api/interfaces/ReferenceResponse.md new file mode 100644 index 00000000..1b759434 --- /dev/null +++ b/docs/api/interfaces/ReferenceResponse.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / ReferenceResponse + +# Interface: ReferenceResponse + +Defined in: [bee-js/src/types/index.ts:344](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L344) + +## Properties + +### reference + +> **reference**: [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:345](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L345) diff --git a/docs/api/interfaces/RemovePeerResponse.md b/docs/api/interfaces/RemovePeerResponse.md new file mode 100644 index 00000000..25fabf4b --- /dev/null +++ b/docs/api/interfaces/RemovePeerResponse.md @@ -0,0 +1,25 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / RemovePeerResponse + +# Interface: RemovePeerResponse + +Defined in: [bee-js/src/types/debug.ts:193](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L193) + +## Properties + +### code + +> **code**: `0` + +Defined in: [bee-js/src/types/debug.ts:195](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L195) + +*** + +### message + +> **message**: `string` + +Defined in: [bee-js/src/types/debug.ts:194](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L194) diff --git a/docs/api/interfaces/ReserveState.md b/docs/api/interfaces/ReserveState.md new file mode 100644 index 00000000..694f01c1 --- /dev/null +++ b/docs/api/interfaces/ReserveState.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / ReserveState + +# Interface: ReserveState + +Defined in: [bee-js/src/types/debug.ts:254](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L254) + +## Properties + +### commitment + +> **commitment**: `number` + +Defined in: [bee-js/src/types/debug.ts:257](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L257) + +*** + +### radius + +> **radius**: `number` + +Defined in: [bee-js/src/types/debug.ts:255](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L255) + +*** + +### storageRadius + +> **storageRadius**: `number` + +Defined in: [bee-js/src/types/debug.ts:256](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L256) diff --git a/docs/api/interfaces/SOCReader.md b/docs/api/interfaces/SOCReader.md new file mode 100644 index 00000000..1cb71d84 --- /dev/null +++ b/docs/api/interfaces/SOCReader.md @@ -0,0 +1,45 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / SOCReader + +# Interface: SOCReader + +Defined in: [bee-js/src/types/index.ts:426](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L426) + +Interface for downloading single owner chunks + +## Extended by + +- [`SOCWriter`](SOCWriter.md) + +## Properties + +### download() + +> **download**: (`identifier`) => `Promise`\<`SingleOwnerChunk`\> + +Defined in: [bee-js/src/types/index.ts:433](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L433) + +Downloads a single owner chunk + +#### Parameters + +##### identifier + +The identifier of the chunk + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](../classes/Identifier.md) + +#### Returns + +`Promise`\<`SingleOwnerChunk`\> + +*** + +### owner + +> `readonly` **owner**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/index.ts:427](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L427) diff --git a/docs/api/interfaces/SOCWriter.md b/docs/api/interfaces/SOCWriter.md new file mode 100644 index 00000000..ed7c92a8 --- /dev/null +++ b/docs/api/interfaces/SOCWriter.md @@ -0,0 +1,91 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / SOCWriter + +# Interface: SOCWriter + +Defined in: [bee-js/src/types/index.ts:439](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L439) + +Interface for downloading and uploading single owner chunks + +## Extends + +- [`SOCReader`](SOCReader.md) + +## Properties + +### download() + +> **download**: (`identifier`) => `Promise`\<`SingleOwnerChunk`\> + +Defined in: [bee-js/src/types/index.ts:433](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L433) + +Downloads a single owner chunk + +#### Parameters + +##### identifier + +The identifier of the chunk + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](../classes/Identifier.md) + +#### Returns + +`Promise`\<`SingleOwnerChunk`\> + +#### Inherited from + +[`SOCReader`](SOCReader.md).[`download`](SOCReader.md#download) + +*** + +### owner + +> `readonly` **owner**: [`EthAddress`](../classes/EthAddress.md) + +Defined in: [bee-js/src/types/index.ts:427](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L427) + +#### Inherited from + +[`SOCReader`](SOCReader.md).[`owner`](SOCReader.md#owner) + +*** + +### upload() + +> **upload**: (`stamp`, `identifier`, `data`, `options?`) => `Promise`\<[`UploadResult`](UploadResult.md)\> + +Defined in: [bee-js/src/types/index.ts:447](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L447) + +Uploads a single owner chunk + +#### Parameters + +##### stamp + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BatchId`](../classes/BatchId.md) + +##### identifier + +The identifier of the chunk + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`Identifier`](../classes/Identifier.md) + +##### data + +`Uint8Array` + +The chunk payload data + +##### options? + +[`UploadOptions`](UploadOptions.md) + +Upload options + +#### Returns + +`Promise`\<[`UploadResult`](UploadResult.md)\> diff --git a/docs/api/interfaces/Settlements.md b/docs/api/interfaces/Settlements.md new file mode 100644 index 00000000..fa9eb210 --- /dev/null +++ b/docs/api/interfaces/Settlements.md @@ -0,0 +1,33 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Settlements + +# Interface: Settlements + +Defined in: [bee-js/src/types/debug.ts:5](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L5) + +## Properties + +### peer + +> **peer**: `string` + +Defined in: [bee-js/src/types/debug.ts:6](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L6) + +*** + +### received + +> **received**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L7) + +*** + +### sent + +> **sent**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L8) diff --git a/docs/api/interfaces/Tag.md b/docs/api/interfaces/Tag.md new file mode 100644 index 00000000..a605e061 --- /dev/null +++ b/docs/api/interfaces/Tag.md @@ -0,0 +1,79 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Tag + +# Interface: Tag + +Defined in: [bee-js/src/types/index.ts:251](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L251) + +Object that contains infromation about progress of upload of data to network. + +## See + +[Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + +## Properties + +### address + +> **address**: `string` + +Defined in: [bee-js/src/types/index.ts:258](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L258) + +*** + +### seen + +> **seen**: `number` + +Defined in: [bee-js/src/types/index.ts:253](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L253) + +*** + +### sent + +> **sent**: `number` + +Defined in: [bee-js/src/types/index.ts:255](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L255) + +*** + +### split + +> **split**: `number` + +Defined in: [bee-js/src/types/index.ts:252](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L252) + +*** + +### startedAt + +> **startedAt**: `string` + +Defined in: [bee-js/src/types/index.ts:259](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L259) + +*** + +### stored + +> **stored**: `number` + +Defined in: [bee-js/src/types/index.ts:254](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L254) + +*** + +### synced + +> **synced**: `number` + +Defined in: [bee-js/src/types/index.ts:256](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L256) + +*** + +### uid + +> **uid**: `number` + +Defined in: [bee-js/src/types/index.ts:257](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L257) diff --git a/docs/api/interfaces/Topology.md b/docs/api/interfaces/Topology.md new file mode 100644 index 00000000..903e45e2 --- /dev/null +++ b/docs/api/interfaces/Topology.md @@ -0,0 +1,209 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Topology + +# Interface: Topology + +Defined in: [bee-js/src/types/debug.ts:205](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L205) + +## Properties + +### baseAddr + +> **baseAddr**: `string` + +Defined in: [bee-js/src/types/debug.ts:206](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L206) + +*** + +### bins + +> **bins**: `object` + +Defined in: [bee-js/src/types/debug.ts:214](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L214) + +#### bin\_0 + +> **bin\_0**: [`Bin`](Bin.md) + +#### bin\_1 + +> **bin\_1**: [`Bin`](Bin.md) + +#### bin\_10 + +> **bin\_10**: [`Bin`](Bin.md) + +#### bin\_11 + +> **bin\_11**: [`Bin`](Bin.md) + +#### bin\_12 + +> **bin\_12**: [`Bin`](Bin.md) + +#### bin\_13 + +> **bin\_13**: [`Bin`](Bin.md) + +#### bin\_14 + +> **bin\_14**: [`Bin`](Bin.md) + +#### bin\_15 + +> **bin\_15**: [`Bin`](Bin.md) + +#### bin\_16 + +> **bin\_16**: [`Bin`](Bin.md) + +#### bin\_17 + +> **bin\_17**: [`Bin`](Bin.md) + +#### bin\_18 + +> **bin\_18**: [`Bin`](Bin.md) + +#### bin\_19 + +> **bin\_19**: [`Bin`](Bin.md) + +#### bin\_2 + +> **bin\_2**: [`Bin`](Bin.md) + +#### bin\_20 + +> **bin\_20**: [`Bin`](Bin.md) + +#### bin\_21 + +> **bin\_21**: [`Bin`](Bin.md) + +#### bin\_22 + +> **bin\_22**: [`Bin`](Bin.md) + +#### bin\_23 + +> **bin\_23**: [`Bin`](Bin.md) + +#### bin\_24 + +> **bin\_24**: [`Bin`](Bin.md) + +#### bin\_25 + +> **bin\_25**: [`Bin`](Bin.md) + +#### bin\_26 + +> **bin\_26**: [`Bin`](Bin.md) + +#### bin\_27 + +> **bin\_27**: [`Bin`](Bin.md) + +#### bin\_28 + +> **bin\_28**: [`Bin`](Bin.md) + +#### bin\_29 + +> **bin\_29**: [`Bin`](Bin.md) + +#### bin\_3 + +> **bin\_3**: [`Bin`](Bin.md) + +#### bin\_30 + +> **bin\_30**: [`Bin`](Bin.md) + +#### bin\_31 + +> **bin\_31**: [`Bin`](Bin.md) + +#### bin\_4 + +> **bin\_4**: [`Bin`](Bin.md) + +#### bin\_5 + +> **bin\_5**: [`Bin`](Bin.md) + +#### bin\_6 + +> **bin\_6**: [`Bin`](Bin.md) + +#### bin\_7 + +> **bin\_7**: [`Bin`](Bin.md) + +#### bin\_8 + +> **bin\_8**: [`Bin`](Bin.md) + +#### bin\_9 + +> **bin\_9**: [`Bin`](Bin.md) + +*** + +### connected + +> **connected**: `number` + +Defined in: [bee-js/src/types/debug.ts:208](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L208) + +*** + +### depth + +> **depth**: `number` + +Defined in: [bee-js/src/types/debug.ts:211](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L211) + +*** + +### networkAvailability + +> **networkAvailability**: `string` + +Defined in: [bee-js/src/types/debug.ts:213](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L213) + +*** + +### nnLowWatermark + +> **nnLowWatermark**: `number` + +Defined in: [bee-js/src/types/debug.ts:210](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L210) + +*** + +### population + +> **population**: `number` + +Defined in: [bee-js/src/types/debug.ts:207](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L207) + +*** + +### reachability + +> **reachability**: `string` + +Defined in: [bee-js/src/types/debug.ts:212](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L212) + +*** + +### timestamp + +> **timestamp**: `string` + +Defined in: [bee-js/src/types/debug.ts:209](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L209) diff --git a/docs/api/interfaces/TransactionInfo.md b/docs/api/interfaces/TransactionInfo.md new file mode 100644 index 00000000..467917ea --- /dev/null +++ b/docs/api/interfaces/TransactionInfo.md @@ -0,0 +1,81 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / TransactionInfo + +# Interface: TransactionInfo + +Defined in: [bee-js/src/types/index.ts:522](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L522) + +## Properties + +### created + +> **created**: `string` + +Defined in: [bee-js/src/types/index.ts:529](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L529) + +*** + +### data + +> **data**: `string` + +Defined in: [bee-js/src/types/index.ts:528](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L528) + +*** + +### description + +> **description**: `string` + +Defined in: [bee-js/src/types/index.ts:530](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L530) + +*** + +### gasLimit + +> **gasLimit**: `number` + +Defined in: [bee-js/src/types/index.ts:527](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L527) + +*** + +### gasPrice + +> **gasPrice**: [`NumberString`](../type-aliases/NumberString.md) + +Defined in: [bee-js/src/types/index.ts:526](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L526) + +*** + +### nonce + +> **nonce**: `number` + +Defined in: [bee-js/src/types/index.ts:525](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L525) + +*** + +### to + +> **to**: `string` + +Defined in: [bee-js/src/types/index.ts:524](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L524) + +*** + +### transactionHash + +> **transactionHash**: [`TransactionId`](../classes/TransactionId.md) + +Defined in: [bee-js/src/types/index.ts:523](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L523) + +*** + +### value + +> **value**: `string` + +Defined in: [bee-js/src/types/index.ts:531](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L531) diff --git a/docs/api/interfaces/TransactionOptions.md b/docs/api/interfaces/TransactionOptions.md new file mode 100644 index 00000000..4392a68b --- /dev/null +++ b/docs/api/interfaces/TransactionOptions.md @@ -0,0 +1,29 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / TransactionOptions + +# Interface: TransactionOptions + +Defined in: [bee-js/src/types/debug.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L39) + +## Properties + +### gasLimit? + +> `optional` **gasLimit**: `string` \| `bigint` \| [`NumberString`](../type-aliases/NumberString.md) + +Defined in: [bee-js/src/types/debug.ts:48](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L48) + +Gas limit for the cashout transaction in WEI + +*** + +### gasPrice? + +> `optional` **gasPrice**: `string` \| `bigint` \| [`NumberString`](../type-aliases/NumberString.md) + +Defined in: [bee-js/src/types/debug.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L43) + +Gas price for the cashout transaction in WEI diff --git a/docs/api/interfaces/TransactionResponse.md b/docs/api/interfaces/TransactionResponse.md new file mode 100644 index 00000000..7e25846e --- /dev/null +++ b/docs/api/interfaces/TransactionResponse.md @@ -0,0 +1,17 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / TransactionResponse + +# Interface: TransactionResponse + +Defined in: [bee-js/src/types/debug.ts:65](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L65) + +## Properties + +### transactionHash + +> **transactionHash**: [`TransactionId`](../classes/TransactionId.md) + +Defined in: [bee-js/src/types/debug.ts:66](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L66) diff --git a/docs/api/interfaces/UploadHeaders.md b/docs/api/interfaces/UploadHeaders.md new file mode 100644 index 00000000..bea0c849 --- /dev/null +++ b/docs/api/interfaces/UploadHeaders.md @@ -0,0 +1,49 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / UploadHeaders + +# Interface: UploadHeaders + +Defined in: [bee-js/src/types/index.ts:238](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L238) + +## Properties + +### swarm-act? + +> `optional` **swarm-act**: `string` + +Defined in: [bee-js/src/types/index.ts:239](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L239) + +*** + +### swarm-encrypt? + +> `optional` **swarm-encrypt**: `string` + +Defined in: [bee-js/src/types/index.ts:241](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L241) + +*** + +### swarm-pin? + +> `optional` **swarm-pin**: `string` + +Defined in: [bee-js/src/types/index.ts:240](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L240) + +*** + +### swarm-postage-batch-id? + +> `optional` **swarm-postage-batch-id**: `string` + +Defined in: [bee-js/src/types/index.ts:243](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L243) + +*** + +### swarm-tag? + +> `optional` **swarm-tag**: `string` + +Defined in: [bee-js/src/types/index.ts:242](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L242) diff --git a/docs/api/interfaces/UploadOptions.md b/docs/api/interfaces/UploadOptions.md new file mode 100644 index 00000000..9467fd36 --- /dev/null +++ b/docs/api/interfaces/UploadOptions.md @@ -0,0 +1,106 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / UploadOptions + +# Interface: UploadOptions + +Defined in: [bee-js/src/types/index.ts:97](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L97) + +## Extended by + +- [`RedundantUploadOptions`](RedundantUploadOptions.md) +- [`FileUploadOptions`](FileUploadOptions.md) +- [`CollectionUploadOptions`](CollectionUploadOptions.md) + +## Properties + +### act? + +> `optional` **act**: `boolean` + +Defined in: [bee-js/src/types/index.ts:101](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L101) + +If set to true, an ACT will be created for the uploaded data. + +*** + +### actHistoryAddress? + +> `optional` **actHistoryAddress**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:103](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L103) + +*** + +### deferred? + +> `optional` **deferred**: `boolean` + +Defined in: [bee-js/src/types/index.ts:143](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L143) + +Determines if the uploaded data should be sent to the network immediately (eq. deferred=false) or in a deferred fashion (eq. deferred=true). + +With deferred style client uploads all the data to Bee node first and only then Bee node starts push the data to network itself. The progress of this upload can be tracked with tags. +With non-deferred style client uploads the data to Bee which immediately starts pushing the data to network. The request is only finished once all the data was pushed through the Bee node to the network. + +In future there will be move to the non-deferred style and even the support for deferred upload will be removed from Bee itself. + +#### Default + +```ts +true +``` + +*** + +### encrypt? + +> `optional` **encrypt**: `boolean` + +Defined in: [bee-js/src/types/index.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L122) + +Will encrypt the uploaded data and return longer hash which also includes the decryption key. + +#### See + + - [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/develop/access-the-swarm/store-with-encryption) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - Reference + +*** + +### pin? + +> `optional` **pin**: `boolean` + +Defined in: [bee-js/src/types/index.ts:113](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L113) + +Will pin the data locally in the Bee node as well. + +Locally pinned data is possible to reupload to network if it disappear. + +#### See + + - [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning) + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + +*** + +### tag? + +> `optional` **tag**: `number` + +Defined in: [bee-js/src/types/index.ts:131](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L131) + +Tags keep track of syncing the data with network. This option allows attach existing Tag UUID to the uploaded data. + +#### See + + - [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post) + - [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing) + +#### Link + +Tag diff --git a/docs/api/interfaces/UploadResult.md b/docs/api/interfaces/UploadResult.md new file mode 100644 index 00000000..8726e78d --- /dev/null +++ b/docs/api/interfaces/UploadResult.md @@ -0,0 +1,41 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / UploadResult + +# Interface: UploadResult + +Defined in: [bee-js/src/types/index.ts:80](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L80) + +Result of upload calls. + +## Properties + +### historyAddress + +> **historyAddress**: `Optional`\<[`Reference`](../classes/Reference.md)\> + +Defined in: [bee-js/src/types/index.ts:94](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L94) + +History address of the uploaded data with ACT. + +*** + +### reference + +> **reference**: [`Reference`](../classes/Reference.md) + +Defined in: [bee-js/src/types/index.ts:84](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L84) + +Reference of the uploaded data + +*** + +### tagUid? + +> `optional` **tagUid**: `number` + +Defined in: [bee-js/src/types/index.ts:89](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L89) + +Automatically created tag's UID. diff --git a/docs/api/interfaces/WalletBalance.md b/docs/api/interfaces/WalletBalance.md new file mode 100644 index 00000000..c2c7b436 --- /dev/null +++ b/docs/api/interfaces/WalletBalance.md @@ -0,0 +1,49 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / WalletBalance + +# Interface: WalletBalance + +Defined in: [bee-js/src/types/debug.ts:267](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L267) + +## Properties + +### bzzBalance + +> **bzzBalance**: [`BZZ`](../classes/BZZ.md) + +Defined in: [bee-js/src/types/debug.ts:268](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L268) + +*** + +### chainID + +> **chainID**: `number` + +Defined in: [bee-js/src/types/debug.ts:270](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L270) + +*** + +### chequebookContractAddress + +> **chequebookContractAddress**: `string` + +Defined in: [bee-js/src/types/debug.ts:271](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L271) + +*** + +### nativeTokenBalance + +> **nativeTokenBalance**: [`DAI`](../classes/DAI.md) + +Defined in: [bee-js/src/types/debug.ts:269](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L269) + +*** + +### walletAddress + +> **walletAddress**: `string` + +Defined in: [bee-js/src/types/debug.ts:272](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L272) diff --git a/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md b/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md new file mode 100644 index 00000000..53e6ad19 --- /dev/null +++ b/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md @@ -0,0 +1,34 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / approximateOverheadForRedundancyLevel + +# Function: approximateOverheadForRedundancyLevel() + +> **approximateOverheadForRedundancyLevel**(`chunks`, `level`, `encrypted`): `number` + +Defined in: [bee-js/src/utils/redundancy.ts:48](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/redundancy.ts#L48) + +Returns an approximate multiplier for the overhead of a given redundancy level. +Redundancy level is a tradeoff between storage overhead and fault tolerance. +Use this number to estimate the amount of chunks that will be stored for a given +redundancy level. + +## Parameters + +### chunks + +`number` + +### level + +[`RedundancyLevel`](../../enumerations/RedundancyLevel.md) + +### encrypted + +`boolean` + +## Returns + +`number` diff --git a/docs/api/namespaces/Utils/getAmountForDuration.md b/docs/api/namespaces/Utils/getAmountForDuration.md new file mode 100644 index 00000000..e9ba8e55 --- /dev/null +++ b/docs/api/namespaces/Utils/getAmountForDuration.md @@ -0,0 +1,37 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getAmountForDuration + +# Function: getAmountForDuration() + +> **getAmountForDuration**(`duration`, `pricePerBlock`, `blockTime`): `bigint` + +Defined in: [bee-js/src/utils/stamps.ts:125](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L125) + +Get the postage batch `amount` required for a given `duration`. + +## Parameters + +### duration + +[`Duration`](../../classes/Duration.md) + +A duration object representing the duration of the storage. + +### pricePerBlock + +`number` + +The price per block in PLUR. + +### blockTime + +`number` + +The block time in seconds. + +## Returns + +`bigint` diff --git a/docs/api/namespaces/Utils/getCollectionSize.md b/docs/api/namespaces/Utils/getCollectionSize.md new file mode 100644 index 00000000..35f06da7 --- /dev/null +++ b/docs/api/namespaces/Utils/getCollectionSize.md @@ -0,0 +1,27 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getCollectionSize + +# Function: getCollectionSize() + +> **getCollectionSize**(`fileList`): `number` + +Defined in: [bee-js/src/utils/collection.ts:44](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/collection.ts#L44) + +Calculate cumulative size of files + +## Parameters + +### fileList + +list of files to check + +`File`[] | `FileList` + +## Returns + +`number` + +size in bytes diff --git a/docs/api/namespaces/Utils/getDepthForSize.md b/docs/api/namespaces/Utils/getDepthForSize.md new file mode 100644 index 00000000..c2c7fa8d --- /dev/null +++ b/docs/api/namespaces/Utils/getDepthForSize.md @@ -0,0 +1,25 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getDepthForSize + +# Function: getDepthForSize() + +> **getDepthForSize**(`size`): `number` + +Defined in: [bee-js/src/utils/stamps.ts:135](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L135) + +Utility function that calculates the depth required for a postage batch to achieve the specified effective size + +## Parameters + +### size + +[`Size`](../../classes/Size.md) + +The effective size of the postage batch + +## Returns + +`number` diff --git a/docs/api/namespaces/Utils/getFolderSize.md b/docs/api/namespaces/Utils/getFolderSize.md new file mode 100644 index 00000000..51473517 --- /dev/null +++ b/docs/api/namespaces/Utils/getFolderSize.md @@ -0,0 +1,27 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getFolderSize + +# Function: getFolderSize() + +> **getFolderSize**(`dir`): `Promise`\<`number`\> + +Defined in: [bee-js/src/utils/collection.node.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/collection.node.ts#L51) + +Calculate folder size recursively + +## Parameters + +### dir + +`string` + +the path to the folder to check + +## Returns + +`Promise`\<`number`\> + +size in bytes diff --git a/docs/api/namespaces/Utils/getRedundancyStat.md b/docs/api/namespaces/Utils/getRedundancyStat.md new file mode 100644 index 00000000..895c46c2 --- /dev/null +++ b/docs/api/namespaces/Utils/getRedundancyStat.md @@ -0,0 +1,21 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getRedundancyStat + +# Function: getRedundancyStat() + +> **getRedundancyStat**(`level?`): `RedundancyStats` + +Defined in: [bee-js/src/utils/redundancy.ts:121](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/redundancy.ts#L121) + +## Parameters + +### level? + +`string` | [`RedundancyLevel`](../../enumerations/RedundancyLevel.md) + +## Returns + +`RedundancyStats` diff --git a/docs/api/namespaces/Utils/getRedundancyStats.md b/docs/api/namespaces/Utils/getRedundancyStats.md new file mode 100644 index 00000000..9a7dc867 --- /dev/null +++ b/docs/api/namespaces/Utils/getRedundancyStats.md @@ -0,0 +1,31 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getRedundancyStats + +# Function: getRedundancyStats() + +> **getRedundancyStats**(): `object` + +Defined in: [bee-js/src/utils/redundancy.ts:107](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/redundancy.ts#L107) + +## Returns + +`object` + +### insane + +> **insane**: `RedundancyStats` + +### medium + +> **medium**: `RedundancyStats` + +### paranoid + +> **paranoid**: `RedundancyStats` + +### strong + +> **strong**: `RedundancyStats` diff --git a/docs/api/namespaces/Utils/getStampCost.md b/docs/api/namespaces/Utils/getStampCost.md new file mode 100644 index 00000000..0fea9020 --- /dev/null +++ b/docs/api/namespaces/Utils/getStampCost.md @@ -0,0 +1,27 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getStampCost + +# Function: getStampCost() + +> **getStampCost**(`depth`, `amount`): [`BZZ`](../../classes/BZZ.md) + +Defined in: [bee-js/src/utils/stamps.ts:97](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L97) + +Utility function that calculates the cost of a postage batch based on its depth and amount. + +## Parameters + +### depth + +`number` + +### amount + +`string` | `bigint` | [`NumberString`](../../type-aliases/NumberString.md) + +## Returns + +[`BZZ`](../../classes/BZZ.md) diff --git a/docs/api/namespaces/Utils/getStampDuration.md b/docs/api/namespaces/Utils/getStampDuration.md new file mode 100644 index 00000000..57637d3b --- /dev/null +++ b/docs/api/namespaces/Utils/getStampDuration.md @@ -0,0 +1,35 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getStampDuration + +# Function: getStampDuration() + +> **getStampDuration**(`amount`, `pricePerBlock`, `blockTime`): [`Duration`](../../classes/Duration.md) + +Defined in: [bee-js/src/utils/stamps.ts:108](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L108) + +Utility function that calculates the TTL of a postage batch based on its amount, price per block and block time. + +For more accurate results, get the price per block and block time from the Bee node or the blockchain. + +## Parameters + +### amount + +`string` | `bigint` | [`NumberString`](../../type-aliases/NumberString.md) + +### pricePerBlock + +`number` + +### blockTime + +`number` + +## Returns + +[`Duration`](../../classes/Duration.md) + +The TTL of the postage batch. diff --git a/docs/api/namespaces/Utils/getStampEffectiveBytes.md b/docs/api/namespaces/Utils/getStampEffectiveBytes.md new file mode 100644 index 00000000..d66c5010 --- /dev/null +++ b/docs/api/namespaces/Utils/getStampEffectiveBytes.md @@ -0,0 +1,28 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getStampEffectiveBytes + +# Function: getStampEffectiveBytes() + +> **getStampEffectiveBytes**(`depth`): `number` + +Defined in: [bee-js/src/utils/stamps.ts:66](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L66) + +Utility function that calculates the effective size of a postage batch based on its depth. + +Below 22 depth the effective size is 0 +Above 34 it's always > 99% + +## Parameters + +### depth + +`number` + +## Returns + +`number` + +The effective size of the postage batch in bytes. diff --git a/docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md b/docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md new file mode 100644 index 00000000..de12ee9f --- /dev/null +++ b/docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md @@ -0,0 +1,15 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getStampEffectiveBytesBreakpoints + +# Function: getStampEffectiveBytesBreakpoints() + +> **getStampEffectiveBytesBreakpoints**(): `Map`\<`number`, `number`\> + +Defined in: [bee-js/src/utils/stamps.ts:84](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L84) + +## Returns + +`Map`\<`number`, `number`\> diff --git a/docs/api/namespaces/Utils/getStampTheoreticalBytes.md b/docs/api/namespaces/Utils/getStampTheoreticalBytes.md new file mode 100644 index 00000000..f0c374fe --- /dev/null +++ b/docs/api/namespaces/Utils/getStampTheoreticalBytes.md @@ -0,0 +1,27 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getStampTheoreticalBytes + +# Function: getStampTheoreticalBytes() + +> **getStampTheoreticalBytes**(`depth`): `number` + +Defined in: [bee-js/src/utils/stamps.ts:29](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L29) + +Utility function that calculates the theoritical maximum size of a postage batch based on its depth. + +For smaller depths (up to 22), this may provide less accurate results. + +## Parameters + +### depth + +`number` + +## Returns + +`number` + +The maximum theoretical size of the postage batch in bytes. diff --git a/docs/api/namespaces/Utils/getStampUsage.md b/docs/api/namespaces/Utils/getStampUsage.md new file mode 100644 index 00000000..1e545d2c --- /dev/null +++ b/docs/api/namespaces/Utils/getStampUsage.md @@ -0,0 +1,35 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / getStampUsage + +# Function: getStampUsage() + +> **getStampUsage**(`utilization`, `depth`, `bucketDepth`): `number` + +Defined in: [bee-js/src/utils/stamps.ts:18](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/stamps.ts#L18) + +Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth. + +For smaller depths (up to 20), this may provide less accurate results. + +## Parameters + +### utilization + +`number` + +### depth + +`number` + +### bucketDepth + +`number` + +## Returns + +`number` + +A number between 0 and 1 representing the usage of the postage batch. diff --git a/docs/api/namespaces/Utils/makeCollectionFromFileList.md b/docs/api/namespaces/Utils/makeCollectionFromFileList.md new file mode 100644 index 00000000..0dd34b18 --- /dev/null +++ b/docs/api/namespaces/Utils/makeCollectionFromFileList.md @@ -0,0 +1,21 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / makeCollectionFromFileList + +# Function: makeCollectionFromFileList() + +> **makeCollectionFromFileList**(`fileList`): [`Collection`](../../type-aliases/Collection.md) + +Defined in: [bee-js/src/utils/collection.ts:30](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/collection.ts#L30) + +## Parameters + +### fileList + +`File`[] | `FileList` + +## Returns + +[`Collection`](../../type-aliases/Collection.md) diff --git a/docs/api/namespaces/Utils/makeMaxTarget.md b/docs/api/namespaces/Utils/makeMaxTarget.md new file mode 100644 index 00000000..bab376f9 --- /dev/null +++ b/docs/api/namespaces/Utils/makeMaxTarget.md @@ -0,0 +1,30 @@ +[**@ethersphere/bee-js**] + +*** + +[@ethersphere/bee-js] / [Utils] / makeMaxTarget + +# Function: makeMaxTarget() + +> **makeMaxTarget**(`target`): `string` + +Defined in: [bee-js/src/utils/pss.ts:11](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/pss.ts#L11) + +Utility function that for given strings/reference takes the most specific +target that Bee node will except. + +## Parameters + +### target + +is a non-prefixed hex string Bee address + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`PeerAddress`](../../classes/PeerAddress.md) + +## Returns + +`string` + +## See + +[Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss) diff --git a/docs/api/type-aliases/BeeRequestOptions.md b/docs/api/type-aliases/BeeRequestOptions.md new file mode 100644 index 00000000..e7cf8ce6 --- /dev/null +++ b/docs/api/type-aliases/BeeRequestOptions.md @@ -0,0 +1,81 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BeeRequestOptions + +# Type Alias: BeeRequestOptions + +> **BeeRequestOptions** = `object` + +Defined in: [bee-js/src/types/index.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L43) + +## Extended by + +- [`BeeOptions`](../interfaces/BeeOptions.md) + +## Properties + +### baseURL? + +> `optional` **baseURL**: `string` + +Defined in: [bee-js/src/types/index.ts:44](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L44) + +*** + +### endlesslyRetry? + +> `optional` **endlesslyRetry**: `boolean` + +Defined in: [bee-js/src/types/index.ts:50](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L50) + +*** + +### headers? + +> `optional` **headers**: `Record`\<`string`, `string`\> + +Defined in: [bee-js/src/types/index.ts:46](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L46) + +*** + +### httpAgent? + +> `optional` **httpAgent**: `unknown` + +Defined in: [bee-js/src/types/index.ts:48](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L48) + +*** + +### httpsAgent? + +> `optional` **httpsAgent**: `unknown` + +Defined in: [bee-js/src/types/index.ts:49](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L49) + +*** + +### onRequest()? + +> `optional` **onRequest**: (`request`) => `void` + +Defined in: [bee-js/src/types/index.ts:47](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L47) + +#### Parameters + +##### request + +[`BeeRequest`](../interfaces/BeeRequest.md) + +#### Returns + +`void` + +*** + +### timeout? + +> `optional` **timeout**: `number` + +Defined in: [bee-js/src/types/index.ts:45](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L45) diff --git a/docs/api/type-aliases/Collection.md b/docs/api/type-aliases/Collection.md new file mode 100644 index 00000000..c425d552 --- /dev/null +++ b/docs/api/type-aliases/Collection.md @@ -0,0 +1,13 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / Collection + +# Type Alias: Collection + +> **Collection** = [`CollectionEntry`](../interfaces/CollectionEntry.md)[] + +Defined in: [bee-js/src/types/index.ts:322](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L322) + +Represents Collections diff --git a/docs/api/type-aliases/HookCallback.md b/docs/api/type-aliases/HookCallback.md new file mode 100644 index 00000000..bc3756b8 --- /dev/null +++ b/docs/api/type-aliases/HookCallback.md @@ -0,0 +1,27 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / HookCallback + +# Type Alias: HookCallback()\ + +> **HookCallback**\<`V`\> = (`value`) => `void` \| `Promise`\<`void`\> + +Defined in: [bee-js/src/types/index.ts:350](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L350) + +## Type Parameters + +### V + +`V` + +## Parameters + +### value + +`V` + +## Returns + +`void` \| `Promise`\<`void`\> diff --git a/docs/api/type-aliases/HttpMethod.md b/docs/api/type-aliases/HttpMethod.md new file mode 100644 index 00000000..570bea12 --- /dev/null +++ b/docs/api/type-aliases/HttpMethod.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / HttpMethod + +# Type Alias: HttpMethod + +> **HttpMethod** = `"GET"` \| `"DELETE"` \| `"POST"` \| `"PATCH"` \| `"PUT"` + +Defined in: [bee-js/src/types/index.ts:348](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L348) diff --git a/docs/api/type-aliases/NumberString.md b/docs/api/type-aliases/NumberString.md new file mode 100644 index 00000000..4b74b47a --- /dev/null +++ b/docs/api/type-aliases/NumberString.md @@ -0,0 +1,19 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NumberString + +# Type Alias: NumberString + +> **NumberString** = `string` & `object` + +Defined in: [bee-js/src/types/index.ts:586](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L586) + +With this type a number should be represented in a string + +## Type declaration + +### \_\_numberString + +> **\_\_numberString**: `never` diff --git a/docs/api/variables/BRANCHES.md b/docs/api/variables/BRANCHES.md new file mode 100644 index 00000000..c964bf25 --- /dev/null +++ b/docs/api/variables/BRANCHES.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / BRANCHES + +# Variable: BRANCHES + +> `const` **BRANCHES**: `128` = `128` + +Defined in: [bee-js/src/types/index.ts:23](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L23) diff --git a/docs/api/variables/CHUNK_SIZE.md b/docs/api/variables/CHUNK_SIZE.md new file mode 100644 index 00000000..954c5b30 --- /dev/null +++ b/docs/api/variables/CHUNK_SIZE.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / CHUNK\_SIZE + +# Variable: CHUNK\_SIZE + +> `const` **CHUNK\_SIZE**: `number` + +Defined in: [bee-js/src/types/index.ts:24](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L24) diff --git a/docs/api/variables/FEED_INDEX_HEX_LENGTH.md b/docs/api/variables/FEED_INDEX_HEX_LENGTH.md new file mode 100644 index 00000000..cef35785 --- /dev/null +++ b/docs/api/variables/FEED_INDEX_HEX_LENGTH.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / FEED\_INDEX\_HEX\_LENGTH + +# Variable: FEED\_INDEX\_HEX\_LENGTH + +> `const` **FEED\_INDEX\_HEX\_LENGTH**: `16` = `16` + +Defined in: [bee-js/src/types/index.ts:41](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L41) diff --git a/docs/api/variables/NULL_ADDRESS.md b/docs/api/variables/NULL_ADDRESS.md new file mode 100644 index 00000000..f6074fbf --- /dev/null +++ b/docs/api/variables/NULL_ADDRESS.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NULL\_ADDRESS + +# Variable: NULL\_ADDRESS + +> `const` **NULL\_ADDRESS**: `Uint8Array`\<`ArrayBuffer`\> + +Defined in: [bee-js/src/utils/constants.ts:6](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/constants.ts#L6) diff --git a/docs/api/variables/NULL_IDENTIFIER.md b/docs/api/variables/NULL_IDENTIFIER.md new file mode 100644 index 00000000..146a11db --- /dev/null +++ b/docs/api/variables/NULL_IDENTIFIER.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NULL\_IDENTIFIER + +# Variable: NULL\_IDENTIFIER + +> `const` **NULL\_IDENTIFIER**: `Uint8Array`\<`ArrayBuffer`\> + +Defined in: [bee-js/src/utils/constants.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/constants.ts#L7) diff --git a/docs/api/variables/NULL_OWNER.md b/docs/api/variables/NULL_OWNER.md new file mode 100644 index 00000000..1c2954a3 --- /dev/null +++ b/docs/api/variables/NULL_OWNER.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NULL\_OWNER + +# Variable: NULL\_OWNER + +> `const` **NULL\_OWNER**: `Uint8Array`\<`ArrayBuffer`\> + +Defined in: [bee-js/src/utils/constants.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/constants.ts#L8) diff --git a/docs/api/variables/NULL_STAMP.md b/docs/api/variables/NULL_STAMP.md new file mode 100644 index 00000000..c0d19c02 --- /dev/null +++ b/docs/api/variables/NULL_STAMP.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NULL\_STAMP + +# Variable: NULL\_STAMP + +> `const` **NULL\_STAMP**: [`BatchId`](../classes/BatchId.md) + +Defined in: [bee-js/src/utils/constants.ts:4](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/constants.ts#L4) diff --git a/docs/api/variables/NULL_TOPIC.md b/docs/api/variables/NULL_TOPIC.md new file mode 100644 index 00000000..59a9a463 --- /dev/null +++ b/docs/api/variables/NULL_TOPIC.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / NULL\_TOPIC + +# Variable: NULL\_TOPIC + +> `const` **NULL\_TOPIC**: [`Topic`](../classes/Topic.md) + +Defined in: [bee-js/src/utils/constants.ts:5](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/constants.ts#L5) diff --git a/docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md b/docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md new file mode 100644 index 00000000..03cbc2e2 --- /dev/null +++ b/docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / PSS\_TARGET\_HEX\_LENGTH\_MAX + +# Variable: PSS\_TARGET\_HEX\_LENGTH\_MAX + +> `const` **PSS\_TARGET\_HEX\_LENGTH\_MAX**: `4` = `4` + +Defined in: [bee-js/src/types/index.ts:26](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L26) diff --git a/docs/api/variables/SECTION_SIZE.md b/docs/api/variables/SECTION_SIZE.md new file mode 100644 index 00000000..651bf93e --- /dev/null +++ b/docs/api/variables/SECTION_SIZE.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / SECTION\_SIZE + +# Variable: SECTION\_SIZE + +> `const` **SECTION\_SIZE**: `32` = `32` + +Defined in: [bee-js/src/types/index.ts:22](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L22) diff --git a/docs/api/variables/STAMPS_DEPTH_MAX.md b/docs/api/variables/STAMPS_DEPTH_MAX.md new file mode 100644 index 00000000..d6f0b5e9 --- /dev/null +++ b/docs/api/variables/STAMPS_DEPTH_MAX.md @@ -0,0 +1,13 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / STAMPS\_DEPTH\_MAX + +# Variable: STAMPS\_DEPTH\_MAX + +> `const` **STAMPS\_DEPTH\_MAX**: `255` = `255` + +Defined in: [bee-js/src/types/index.ts:36](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L36) + +Maximal depth that can be used for creation of postage batch diff --git a/docs/api/variables/STAMPS_DEPTH_MIN.md b/docs/api/variables/STAMPS_DEPTH_MIN.md new file mode 100644 index 00000000..bc6f8eea --- /dev/null +++ b/docs/api/variables/STAMPS_DEPTH_MIN.md @@ -0,0 +1,13 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / STAMPS\_DEPTH\_MIN + +# Variable: STAMPS\_DEPTH\_MIN + +> `const` **STAMPS\_DEPTH\_MIN**: `17` = `17` + +Defined in: [bee-js/src/types/index.ts:31](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L31) + +Minimal depth that can be used for creation of postage batch diff --git a/docs/api/variables/SUPPORTED_BEE_VERSION.md b/docs/api/variables/SUPPORTED_BEE_VERSION.md new file mode 100644 index 00000000..6b4ed674 --- /dev/null +++ b/docs/api/variables/SUPPORTED_BEE_VERSION.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / SUPPORTED\_BEE\_VERSION + +# Variable: SUPPORTED\_BEE\_VERSION + +> `const` **SUPPORTED\_BEE\_VERSION**: `string` + +Defined in: [bee-js/src/modules/debug/status.ts:9](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/modules/debug/status.ts#L9) diff --git a/docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md b/docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md new file mode 100644 index 00000000..d3bc237d --- /dev/null +++ b/docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / SUPPORTED\_BEE\_VERSION\_EXACT + +# Variable: SUPPORTED\_BEE\_VERSION\_EXACT + +> `const` **SUPPORTED\_BEE\_VERSION\_EXACT**: `"2.4.0-390a402e"` = `'2.4.0-390a402e'` + +Defined in: [bee-js/src/modules/debug/status.ts:8](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/modules/debug/status.ts#L8) diff --git a/docs/api/variables/SWARM_GATEWAY_URL.md b/docs/api/variables/SWARM_GATEWAY_URL.md new file mode 100644 index 00000000..1ffdb302 --- /dev/null +++ b/docs/api/variables/SWARM_GATEWAY_URL.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / SWARM\_GATEWAY\_URL + +# Variable: SWARM\_GATEWAY\_URL + +> `const` **SWARM\_GATEWAY\_URL**: `"https://api.gateway.ethswarm.org"` = `'https://api.gateway.ethswarm.org'` + +Defined in: [bee-js/src/utils/constants.ts:3](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/constants.ts#L3) diff --git a/docs/api/variables/TAGS_LIMIT_MAX.md b/docs/api/variables/TAGS_LIMIT_MAX.md new file mode 100644 index 00000000..366001c0 --- /dev/null +++ b/docs/api/variables/TAGS_LIMIT_MAX.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / TAGS\_LIMIT\_MAX + +# Variable: TAGS\_LIMIT\_MAX + +> `const` **TAGS\_LIMIT\_MAX**: `1000` = `1000` + +Defined in: [bee-js/src/types/index.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L39) diff --git a/docs/api/variables/TAGS_LIMIT_MIN.md b/docs/api/variables/TAGS_LIMIT_MIN.md new file mode 100644 index 00000000..11c12c33 --- /dev/null +++ b/docs/api/variables/TAGS_LIMIT_MIN.md @@ -0,0 +1,11 @@ +[**@ethersphere/bee-js**](../Overview.md) + +*** + +[@ethersphere/bee-js](../Overview.md) / TAGS\_LIMIT\_MIN + +# Variable: TAGS\_LIMIT\_MIN + +> `const` **TAGS\_LIMIT\_MIN**: `1` = `1` + +Defined in: [bee-js/src/types/index.ts:38](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L38) diff --git a/sidebars.js b/sidebars.js index c24b730a..3972de3a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -51,6 +51,49 @@ module.exports = { ], collapsed: false }, + { + type: 'category', + label: 'API Reference', + items: [ + 'api/Overview', + { + type: 'category', + label: 'Namespaces', + items: [{ type: 'autogenerated', dirName: 'api/namespaces' }] + }, + { + type: 'category', + label: 'Enumerations', + items: [{ type: 'autogenerated', dirName: 'api/enumerations' }] + }, + { + type: 'category', + label: 'Classes', + items: [{ type: 'autogenerated', dirName: 'api/classes' }] + }, + { + type: 'category', + label: 'Interfaces', + items: [{ type: 'autogenerated', dirName: 'api/interfaces' }] + }, + { + type: 'category', + label: 'Type Aliases', + items: [{ type: 'autogenerated', dirName: 'api/type-aliases' }] + }, + { + type: 'category', + label: 'Variables', + items: [{ type: 'autogenerated', dirName: 'api/variables' }] + }, + { + type: 'category', + label: 'Functions', + items: [{ type: 'autogenerated', dirName: 'api/functions' }] + }, + ], + collapsed: false + } ] } From 39fdc8544aa779ec22802bc95722fc9483080663 Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 01:19:31 +0700 Subject: [PATCH 2/8] update header sizes --- src/css/custom.css | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/src/css/custom.css b/src/css/custom.css index 8345b1fc..81076e88 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -138,3 +138,34 @@ header { padding: 3rem; } } + +/* Global heading font sizes */ +h1 { + font-size: 2rem !important; +} + +h2 { + font-size: 1.6rem !important; +} + +h3 { + font-size: 1.3rem !important; +} + +h4 { + font-size: 1.15rem !important; +} + +h5 { + font-size: 1rem !important; +} + +h6 { + font-size: 0.9rem !important; +} + +/* Slightly larger h1 only inside page
blocks (top of docs pages) */ +.header h1, +article header h1 { + font-size: 2.5rem !important; +} \ No newline at end of file From 083bedeac190ed6cb2b1bf797c000b4f49c8cfec Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 01:26:53 +0700 Subject: [PATCH 3/8] update overview frontmatter --- docs/api/Overview.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api/Overview.md b/docs/api/Overview.md index ae7a06dc..e598c9e5 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,3 +1,10 @@ +--- +id: Overview +title: Overview +slug: /docs/api/ +sidebar_position: 0 +--- + **@ethersphere/bee-js** *** From ef53ac7b9c24e18adb8926f9bb646cbefe05f4fd Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 01:30:20 +0700 Subject: [PATCH 4/8] update slug --- docs/api/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/Overview.md b/docs/api/Overview.md index e598c9e5..4c2dcd71 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,7 +1,7 @@ --- id: Overview title: Overview -slug: /docs/api/ +slug: /api/ sidebar_position: 0 --- From b918c043fc7550a9c4bc37d5d387bf9c3b620601 Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 01:36:08 +0700 Subject: [PATCH 5/8] reduce header sizes --- src/css/custom.css | 38 ++++++++++---------------------------- 1 file changed, 10 insertions(+), 28 deletions(-) diff --git a/src/css/custom.css b/src/css/custom.css index 81076e88..3c8afa59 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -139,33 +139,15 @@ header { } } -/* Global heading font sizes */ -h1 { - font-size: 2rem !important; -} - -h2 { - font-size: 1.6rem !important; -} - -h3 { - font-size: 1.3rem !important; -} - -h4 { - font-size: 1.15rem !important; +:root { + --ifm-h1-font-size: 2rem; + --ifm-h2-font-size: 1.6rem; + --ifm-h3-font-size: 1.3rem; + --ifm-h4-font-size: 1.15rem; + --ifm-h5-font-size: 1rem; + --ifm-h6-font-size: 0.9rem; } - -h5 { - font-size: 1rem !important; +article header h1, +.header h1 { + font-size: 2.2rem !important; } - -h6 { - font-size: 0.9rem !important; -} - -/* Slightly larger h1 only inside page
blocks (top of docs pages) */ -.header h1, -article header h1 { - font-size: 2.5rem !important; -} \ No newline at end of file From 919f325d633dd495663b1835a835f0a4c8d72c27 Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 01:56:47 +0700 Subject: [PATCH 6/8] remove breadcrumbs --- docs/api/Overview.md | 4 +--- docs/api/classes/BZZ.md | 6 ------ docs/api/classes/BatchId.md | 6 ------ docs/api/classes/Bee.md | 6 ------ docs/api/classes/BeeArgumentError.md | 6 ------ docs/api/classes/BeeDev.md | 6 ------ docs/api/classes/BeeError.md | 6 ------ docs/api/classes/BeeResponseError.md | 6 ------ docs/api/classes/Bytes.md | 6 ------ docs/api/classes/DAI.md | 6 ------ docs/api/classes/Duration.md | 6 ------ docs/api/classes/EthAddress.md | 6 ------ docs/api/classes/FeedIndex.md | 6 ------ docs/api/classes/Identifier.md | 6 ------ docs/api/classes/MantarayNode.md | 6 ------ docs/api/classes/PeerAddress.md | 6 ------ docs/api/classes/PrivateKey.md | 6 ------ docs/api/classes/PublicKey.md | 6 ------ docs/api/classes/Reference.md | 6 ------ docs/api/classes/Signature.md | 6 ------ docs/api/classes/Size.md | 6 ------ docs/api/classes/Span.md | 6 ------ docs/api/classes/Stamper.md | 6 ------ docs/api/classes/Topic.md | 6 ------ docs/api/classes/TransactionId.md | 6 ------ docs/api/enumerations/BeeModes.md | 6 ------ docs/api/enumerations/RedundancyLevel.md | 6 ------ docs/api/enumerations/RedundancyStrategy.md | 6 ------ docs/api/functions/toBeeMode.md | 6 ------ docs/api/interfaces/AllSettlements.md | 6 ------ docs/api/interfaces/AllTagsOptions.md | 6 ------ docs/api/interfaces/BalanceResponse.md | 6 ------ docs/api/interfaces/BatchBucket.md | 6 ------ docs/api/interfaces/BeeOptions.md | 6 ------ docs/api/interfaces/BeeRequest.md | 6 ------ docs/api/interfaces/BeeResponse.md | 6 ------ docs/api/interfaces/BeeVersions.md | 6 ------ docs/api/interfaces/Bin.md | 6 ------ docs/api/interfaces/CashoutResult.md | 6 ------ docs/api/interfaces/ChainState.md | 6 ------ docs/api/interfaces/Cheque.md | 6 ------ docs/api/interfaces/ChequebookAddressResponse.md | 6 ------ docs/api/interfaces/ChequebookBalanceResponse.md | 6 ------ docs/api/interfaces/CollectionEntry.md | 6 ------ docs/api/interfaces/CollectionUploadOptions.md | 6 ------ docs/api/interfaces/Data.md | 6 ------ docs/api/interfaces/DebugStatus.md | 6 ------ docs/api/interfaces/DownloadOptions.md | 6 ------ docs/api/interfaces/Envelope.md | 6 ------ docs/api/interfaces/EnvelopeWithBatchId.md | 6 ------ docs/api/interfaces/FeedReader.md | 6 ------ docs/api/interfaces/FeedWriter.md | 6 ------ docs/api/interfaces/FileData.md | 6 ------ docs/api/interfaces/FileHeaders.md | 6 ------ docs/api/interfaces/FileUploadOptions.md | 6 ------ docs/api/interfaces/GetGranteesResult.md | 6 ------ docs/api/interfaces/GlobalPostageBatch.md | 6 ------ docs/api/interfaces/GranteesResult.md | 6 ------ docs/api/interfaces/GsocMessageHandler.md | 6 ------ docs/api/interfaces/GsocSubscription.md | 6 ------ docs/api/interfaces/Health.md | 6 ------ docs/api/interfaces/LastCashoutActionResponse.md | 6 ------ docs/api/interfaces/LastChequesForPeerResponse.md | 6 ------ docs/api/interfaces/LastChequesResponse.md | 6 ------ docs/api/interfaces/NodeAddresses.md | 6 ------ docs/api/interfaces/NodeInfo.md | 6 ------ docs/api/interfaces/Peer.md | 6 ------ docs/api/interfaces/PeerBalance.md | 6 ------ docs/api/interfaces/Pin.md | 6 ------ docs/api/interfaces/PingResponse.md | 6 ------ docs/api/interfaces/PostageBatch.md | 6 ------ docs/api/interfaces/PostageBatchBuckets.md | 6 ------ docs/api/interfaces/PostageBatchOptions.md | 6 ------ docs/api/interfaces/PssMessageHandler.md | 6 ------ docs/api/interfaces/PssSubscription.md | 6 ------ docs/api/interfaces/Readiness.md | 6 ------ docs/api/interfaces/RedistributionState.md | 6 ------ docs/api/interfaces/RedundantUploadOptions.md | 6 ------ docs/api/interfaces/ReferenceInformation.md | 6 ------ docs/api/interfaces/ReferenceResponse.md | 6 ------ docs/api/interfaces/RemovePeerResponse.md | 6 ------ docs/api/interfaces/ReserveState.md | 6 ------ docs/api/interfaces/SOCReader.md | 6 ------ docs/api/interfaces/SOCWriter.md | 6 ------ docs/api/interfaces/Settlements.md | 6 ------ docs/api/interfaces/Tag.md | 6 ------ docs/api/interfaces/Topology.md | 6 ------ docs/api/interfaces/TransactionInfo.md | 6 ------ docs/api/interfaces/TransactionOptions.md | 6 ------ docs/api/interfaces/TransactionResponse.md | 6 ------ docs/api/interfaces/UploadHeaders.md | 6 ------ docs/api/interfaces/UploadOptions.md | 6 ------ docs/api/interfaces/UploadResult.md | 6 ------ docs/api/interfaces/WalletBalance.md | 6 ------ .../Utils/approximateOverheadForRedundancyLevel.md | 4 ---- docs/api/namespaces/Utils/getAmountForDuration.md | 4 ---- docs/api/namespaces/Utils/getCollectionSize.md | 4 ---- docs/api/namespaces/Utils/getDepthForSize.md | 4 ---- docs/api/namespaces/Utils/getFolderSize.md | 4 ---- docs/api/namespaces/Utils/getRedundancyStat.md | 4 ---- docs/api/namespaces/Utils/getRedundancyStats.md | 4 ---- docs/api/namespaces/Utils/getStampCost.md | 4 ---- docs/api/namespaces/Utils/getStampDuration.md | 4 ---- docs/api/namespaces/Utils/getStampEffectiveBytes.md | 4 ---- .../namespaces/Utils/getStampEffectiveBytesBreakpoints.md | 4 ---- docs/api/namespaces/Utils/getStampTheoreticalBytes.md | 4 ---- docs/api/namespaces/Utils/getStampUsage.md | 4 ---- docs/api/namespaces/Utils/makeCollectionFromFileList.md | 4 ---- docs/api/namespaces/Utils/makeMaxTarget.md | 4 ---- docs/api/type-aliases/BeeRequestOptions.md | 6 ------ docs/api/type-aliases/Collection.md | 6 ------ docs/api/type-aliases/HookCallback.md | 6 ------ docs/api/type-aliases/HttpMethod.md | 6 ------ docs/api/type-aliases/NumberString.md | 6 ------ docs/api/variables/BRANCHES.md | 6 ------ docs/api/variables/CHUNK_SIZE.md | 6 ------ docs/api/variables/FEED_INDEX_HEX_LENGTH.md | 6 ------ docs/api/variables/NULL_ADDRESS.md | 6 ------ docs/api/variables/NULL_IDENTIFIER.md | 6 ------ docs/api/variables/NULL_OWNER.md | 6 ------ docs/api/variables/NULL_STAMP.md | 6 ------ docs/api/variables/NULL_TOPIC.md | 6 ------ docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md | 6 ------ docs/api/variables/SECTION_SIZE.md | 6 ------ docs/api/variables/STAMPS_DEPTH_MAX.md | 6 ------ docs/api/variables/STAMPS_DEPTH_MIN.md | 6 ------ docs/api/variables/SUPPORTED_BEE_VERSION.md | 6 ------ docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md | 6 ------ docs/api/variables/SWARM_GATEWAY_URL.md | 6 ------ docs/api/variables/TAGS_LIMIT_MAX.md | 6 ------ docs/api/variables/TAGS_LIMIT_MIN.md | 6 ------ 131 files changed, 1 insertion(+), 753 deletions(-) diff --git a/docs/api/Overview.md b/docs/api/Overview.md index 4c2dcd71..0f5f7d8b 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,6 +1,4 @@ ---- -id: Overview -title: Overview +title: API Reference slug: /api/ sidebar_position: 0 --- diff --git a/docs/api/classes/BZZ.md b/docs/api/classes/BZZ.md index 466ed6d9..f2c7697f 100644 --- a/docs/api/classes/BZZ.md +++ b/docs/api/classes/BZZ.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BZZ - # Class: BZZ Defined in: [bee-js/src/utils/tokens.ts:4](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L4) diff --git a/docs/api/classes/BatchId.md b/docs/api/classes/BatchId.md index 54717924..74e7f011 100644 --- a/docs/api/classes/BatchId.md +++ b/docs/api/classes/BatchId.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BatchId - # Class: BatchId Defined in: [bee-js/src/utils/typed-bytes.ts:147](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L147) diff --git a/docs/api/classes/Bee.md b/docs/api/classes/Bee.md index 8bfc7eeb..0acb5d97 100644 --- a/docs/api/classes/Bee.md +++ b/docs/api/classes/Bee.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Bee - # Class: Bee Defined in: [bee-js/src/bee.ts:142](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee.ts#L142) diff --git a/docs/api/classes/BeeArgumentError.md b/docs/api/classes/BeeArgumentError.md index e667e443..483c4113 100644 --- a/docs/api/classes/BeeArgumentError.md +++ b/docs/api/classes/BeeArgumentError.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeArgumentError - # Class: BeeArgumentError Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L7) diff --git a/docs/api/classes/BeeDev.md b/docs/api/classes/BeeDev.md index 90842dd7..75e6c161 100644 --- a/docs/api/classes/BeeDev.md +++ b/docs/api/classes/BeeDev.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeDev - # Class: BeeDev Defined in: [bee-js/src/bee-dev.ts:6](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/bee-dev.ts#L6) diff --git a/docs/api/classes/BeeError.md b/docs/api/classes/BeeError.md index ee3c0177..2c6a533a 100644 --- a/docs/api/classes/BeeError.md +++ b/docs/api/classes/BeeError.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeError - # Class: BeeError Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L1) diff --git a/docs/api/classes/BeeResponseError.md b/docs/api/classes/BeeResponseError.md index 7482560a..0b067715 100644 --- a/docs/api/classes/BeeResponseError.md +++ b/docs/api/classes/BeeResponseError.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeResponseError - # Class: BeeResponseError Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/error.ts#L13) diff --git a/docs/api/classes/Bytes.md b/docs/api/classes/Bytes.md index daacce40..dd9d2694 100644 --- a/docs/api/classes/Bytes.md +++ b/docs/api/classes/Bytes.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Bytes - # Class: Bytes Defined in: [bee-js/src/utils/bytes.ts:6](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/bytes.ts#L6) diff --git a/docs/api/classes/DAI.md b/docs/api/classes/DAI.md index e0fb63bf..f9069095 100644 --- a/docs/api/classes/DAI.md +++ b/docs/api/classes/DAI.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / DAI - # Class: DAI Defined in: [bee-js/src/utils/tokens.ts:94](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L94) diff --git a/docs/api/classes/Duration.md b/docs/api/classes/Duration.md index b656f462..8d1671e5 100644 --- a/docs/api/classes/Duration.md +++ b/docs/api/classes/Duration.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Duration - # Class: Duration Defined in: [bee-js/src/utils/duration.ts:1](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/duration.ts#L1) diff --git a/docs/api/classes/EthAddress.md b/docs/api/classes/EthAddress.md index c2a71b00..51d2f3ad 100644 --- a/docs/api/classes/EthAddress.md +++ b/docs/api/classes/EthAddress.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / EthAddress - # Class: EthAddress Defined in: [bee-js/src/utils/typed-bytes.ts:66](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L66) diff --git a/docs/api/classes/FeedIndex.md b/docs/api/classes/FeedIndex.md index 6896ec24..58e8be83 100644 --- a/docs/api/classes/FeedIndex.md +++ b/docs/api/classes/FeedIndex.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / FeedIndex - # Class: FeedIndex Defined in: [bee-js/src/utils/typed-bytes.ts:202](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L202) diff --git a/docs/api/classes/Identifier.md b/docs/api/classes/Identifier.md index 5764be9b..ce47838c 100644 --- a/docs/api/classes/Identifier.md +++ b/docs/api/classes/Identifier.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Identifier - # Class: Identifier Defined in: [bee-js/src/utils/typed-bytes.ts:77](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L77) diff --git a/docs/api/classes/MantarayNode.md b/docs/api/classes/MantarayNode.md index 6814e541..1a1931ef 100644 --- a/docs/api/classes/MantarayNode.md +++ b/docs/api/classes/MantarayNode.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / MantarayNode - # Class: MantarayNode Defined in: [bee-js/src/manifest/manifest.ts:121](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/manifest/manifest.ts#L121) diff --git a/docs/api/classes/PeerAddress.md b/docs/api/classes/PeerAddress.md index 15a0c41e..a3a0d41a 100644 --- a/docs/api/classes/PeerAddress.md +++ b/docs/api/classes/PeerAddress.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PeerAddress - # Class: PeerAddress Defined in: [bee-js/src/utils/typed-bytes.ts:140](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L140) diff --git a/docs/api/classes/PrivateKey.md b/docs/api/classes/PrivateKey.md index d19ec912..eca385f5 100644 --- a/docs/api/classes/PrivateKey.md +++ b/docs/api/classes/PrivateKey.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PrivateKey - # Class: PrivateKey Defined in: [bee-js/src/utils/typed-bytes.ts:9](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L9) diff --git a/docs/api/classes/PublicKey.md b/docs/api/classes/PublicKey.md index 0c24b6f0..f260357c 100644 --- a/docs/api/classes/PublicKey.md +++ b/docs/api/classes/PublicKey.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PublicKey - # Class: PublicKey Defined in: [bee-js/src/utils/typed-bytes.ts:34](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L34) diff --git a/docs/api/classes/Reference.md b/docs/api/classes/Reference.md index 16726e3b..80d771fd 100644 --- a/docs/api/classes/Reference.md +++ b/docs/api/classes/Reference.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Reference - # Class: Reference Defined in: [bee-js/src/utils/typed-bytes.ts:88](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L88) diff --git a/docs/api/classes/Signature.md b/docs/api/classes/Signature.md index 6fb56960..0bd2af22 100644 --- a/docs/api/classes/Signature.md +++ b/docs/api/classes/Signature.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Signature - # Class: Signature Defined in: [bee-js/src/utils/typed-bytes.ts:154](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L154) diff --git a/docs/api/classes/Size.md b/docs/api/classes/Size.md index ae211e5d..3a5ba16a 100644 --- a/docs/api/classes/Size.md +++ b/docs/api/classes/Size.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Size - # Class: Size Defined in: [bee-js/src/utils/size.ts:10](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/size.ts#L10) diff --git a/docs/api/classes/Span.md b/docs/api/classes/Span.md index 50906735..ed003247 100644 --- a/docs/api/classes/Span.md +++ b/docs/api/classes/Span.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Span - # Class: Span Defined in: [bee-js/src/utils/typed-bytes.ts:121](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L121) diff --git a/docs/api/classes/Stamper.md b/docs/api/classes/Stamper.md index 354c4923..2f12a01d 100644 --- a/docs/api/classes/Stamper.md +++ b/docs/api/classes/Stamper.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Stamper - # Class: Stamper Defined in: [bee-js/src/stamper/stamper.ts:5](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/stamper/stamper.ts#L5) diff --git a/docs/api/classes/Topic.md b/docs/api/classes/Topic.md index 0912a65e..e94e66e9 100644 --- a/docs/api/classes/Topic.md +++ b/docs/api/classes/Topic.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Topic - # Class: Topic Defined in: [bee-js/src/utils/typed-bytes.ts:189](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L189) diff --git a/docs/api/classes/TransactionId.md b/docs/api/classes/TransactionId.md index 35d72955..8a74d782 100644 --- a/docs/api/classes/TransactionId.md +++ b/docs/api/classes/TransactionId.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / TransactionId - # Class: TransactionId Defined in: [bee-js/src/utils/typed-bytes.ts:114](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/typed-bytes.ts#L114) diff --git a/docs/api/enumerations/BeeModes.md b/docs/api/enumerations/BeeModes.md index b6f2886d..4fabde7e 100644 --- a/docs/api/enumerations/BeeModes.md +++ b/docs/api/enumerations/BeeModes.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeModes - # Enumeration: BeeModes Defined in: [bee-js/src/types/debug.ts:129](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L129) diff --git a/docs/api/enumerations/RedundancyLevel.md b/docs/api/enumerations/RedundancyLevel.md index 16d17b07..5c380049 100644 --- a/docs/api/enumerations/RedundancyLevel.md +++ b/docs/api/enumerations/RedundancyLevel.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / RedundancyLevel - # Enumeration: RedundancyLevel Defined in: [bee-js/src/types/index.ts:150](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L150) diff --git a/docs/api/enumerations/RedundancyStrategy.md b/docs/api/enumerations/RedundancyStrategy.md index 96f5c1d7..bfd9faf1 100644 --- a/docs/api/enumerations/RedundancyStrategy.md +++ b/docs/api/enumerations/RedundancyStrategy.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / RedundancyStrategy - # Enumeration: RedundancyStrategy Defined in: [bee-js/src/types/index.ts:172](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L172) diff --git a/docs/api/functions/toBeeMode.md b/docs/api/functions/toBeeMode.md index b0673b5c..1ea91268 100644 --- a/docs/api/functions/toBeeMode.md +++ b/docs/api/functions/toBeeMode.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / toBeeMode - # Function: toBeeMode() > **toBeeMode**(`value`): [`BeeModes`](../enumerations/BeeModes.md) diff --git a/docs/api/interfaces/AllSettlements.md b/docs/api/interfaces/AllSettlements.md index d987fe27..52b02e68 100644 --- a/docs/api/interfaces/AllSettlements.md +++ b/docs/api/interfaces/AllSettlements.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / AllSettlements - # Interface: AllSettlements Defined in: [bee-js/src/types/debug.ts:11](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L11) diff --git a/docs/api/interfaces/AllTagsOptions.md b/docs/api/interfaces/AllTagsOptions.md index b2b924c5..d458e4c6 100644 --- a/docs/api/interfaces/AllTagsOptions.md +++ b/docs/api/interfaces/AllTagsOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / AllTagsOptions - # Interface: AllTagsOptions Defined in: [bee-js/src/types/index.ts:262](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L262) diff --git a/docs/api/interfaces/BalanceResponse.md b/docs/api/interfaces/BalanceResponse.md index 4afd1b1f..432237fd 100644 --- a/docs/api/interfaces/BalanceResponse.md +++ b/docs/api/interfaces/BalanceResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BalanceResponse - # Interface: BalanceResponse Defined in: [bee-js/src/types/debug.ts:90](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L90) diff --git a/docs/api/interfaces/BatchBucket.md b/docs/api/interfaces/BatchBucket.md index a9ccee10..5db3a3bd 100644 --- a/docs/api/interfaces/BatchBucket.md +++ b/docs/api/interfaces/BatchBucket.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BatchBucket - # Interface: BatchBucket Defined in: [bee-js/src/types/index.ts:510](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L510) diff --git a/docs/api/interfaces/BeeOptions.md b/docs/api/interfaces/BeeOptions.md index 5ebbb60a..75fd9132 100644 --- a/docs/api/interfaces/BeeOptions.md +++ b/docs/api/interfaces/BeeOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeOptions - # Interface: BeeOptions Defined in: [bee-js/src/types/index.ts:53](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L53) diff --git a/docs/api/interfaces/BeeRequest.md b/docs/api/interfaces/BeeRequest.md index da765f3b..d9e67d3f 100644 --- a/docs/api/interfaces/BeeRequest.md +++ b/docs/api/interfaces/BeeRequest.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeRequest - # Interface: BeeRequest Defined in: [bee-js/src/types/index.ts:352](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L352) diff --git a/docs/api/interfaces/BeeResponse.md b/docs/api/interfaces/BeeResponse.md index af76f0c8..6cb4d63f 100644 --- a/docs/api/interfaces/BeeResponse.md +++ b/docs/api/interfaces/BeeResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeResponse - # Interface: BeeResponse Defined in: [bee-js/src/types/index.ts:359](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L359) diff --git a/docs/api/interfaces/BeeVersions.md b/docs/api/interfaces/BeeVersions.md index 3fb068ef..d4b38592 100644 --- a/docs/api/interfaces/BeeVersions.md +++ b/docs/api/interfaces/BeeVersions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeVersions - # Interface: BeeVersions Defined in: [bee-js/src/types/debug.ts:122](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L122) diff --git a/docs/api/interfaces/Bin.md b/docs/api/interfaces/Bin.md index bd953813..efe8dcbc 100644 --- a/docs/api/interfaces/Bin.md +++ b/docs/api/interfaces/Bin.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Bin - # Interface: Bin Defined in: [bee-js/src/types/debug.ts:198](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L198) diff --git a/docs/api/interfaces/CashoutResult.md b/docs/api/interfaces/CashoutResult.md index 8bcab4dd..03699fc4 100644 --- a/docs/api/interfaces/CashoutResult.md +++ b/docs/api/interfaces/CashoutResult.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / CashoutResult - # Interface: CashoutResult Defined in: [bee-js/src/types/debug.ts:51](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L51) diff --git a/docs/api/interfaces/ChainState.md b/docs/api/interfaces/ChainState.md index f279b56e..48fc117b 100644 --- a/docs/api/interfaces/ChainState.md +++ b/docs/api/interfaces/ChainState.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / ChainState - # Interface: ChainState Defined in: [bee-js/src/types/debug.ts:260](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L260) diff --git a/docs/api/interfaces/Cheque.md b/docs/api/interfaces/Cheque.md index d1747493..7daf5904 100644 --- a/docs/api/interfaces/Cheque.md +++ b/docs/api/interfaces/Cheque.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Cheque - # Interface: Cheque Defined in: [bee-js/src/types/debug.ts:69](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L69) diff --git a/docs/api/interfaces/ChequebookAddressResponse.md b/docs/api/interfaces/ChequebookAddressResponse.md index 65fe6310..d1c47538 100644 --- a/docs/api/interfaces/ChequebookAddressResponse.md +++ b/docs/api/interfaces/ChequebookAddressResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / ChequebookAddressResponse - # Interface: ChequebookAddressResponse Defined in: [bee-js/src/types/debug.ts:30](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L30) diff --git a/docs/api/interfaces/ChequebookBalanceResponse.md b/docs/api/interfaces/ChequebookBalanceResponse.md index 4475b0ea..1f65813b 100644 --- a/docs/api/interfaces/ChequebookBalanceResponse.md +++ b/docs/api/interfaces/ChequebookBalanceResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / ChequebookBalanceResponse - # Interface: ChequebookBalanceResponse Defined in: [bee-js/src/types/debug.ts:34](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L34) diff --git a/docs/api/interfaces/CollectionEntry.md b/docs/api/interfaces/CollectionEntry.md index 7734918b..19c3216a 100644 --- a/docs/api/interfaces/CollectionEntry.md +++ b/docs/api/interfaces/CollectionEntry.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / CollectionEntry - # Interface: CollectionEntry Defined in: [bee-js/src/types/index.ts:312](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L312) diff --git a/docs/api/interfaces/CollectionUploadOptions.md b/docs/api/interfaces/CollectionUploadOptions.md index e05342c3..01752573 100644 --- a/docs/api/interfaces/CollectionUploadOptions.md +++ b/docs/api/interfaces/CollectionUploadOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / CollectionUploadOptions - # Interface: CollectionUploadOptions Defined in: [bee-js/src/types/index.ts:218](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L218) diff --git a/docs/api/interfaces/Data.md b/docs/api/interfaces/Data.md index 7e75edf6..f1d1182c 100644 --- a/docs/api/interfaces/Data.md +++ b/docs/api/interfaces/Data.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Data - # Interface: Data Defined in: [bee-js/src/types/index.ts:292](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L292) diff --git a/docs/api/interfaces/DebugStatus.md b/docs/api/interfaces/DebugStatus.md index 0da8cde6..4ffc5f42 100644 --- a/docs/api/interfaces/DebugStatus.md +++ b/docs/api/interfaces/DebugStatus.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / DebugStatus - # Interface: DebugStatus Defined in: [bee-js/src/types/debug.ts:94](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L94) diff --git a/docs/api/interfaces/DownloadOptions.md b/docs/api/interfaces/DownloadOptions.md index 6d8d4560..f325192e 100644 --- a/docs/api/interfaces/DownloadOptions.md +++ b/docs/api/interfaces/DownloadOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / DownloadOptions - # Interface: DownloadOptions Defined in: [bee-js/src/types/index.ts:179](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L179) diff --git a/docs/api/interfaces/Envelope.md b/docs/api/interfaces/Envelope.md index 0d4b3a56..71158faf 100644 --- a/docs/api/interfaces/Envelope.md +++ b/docs/api/interfaces/Envelope.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Envelope - # Interface: Envelope Defined in: [bee-js/src/types/index.ts:572](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L572) diff --git a/docs/api/interfaces/EnvelopeWithBatchId.md b/docs/api/interfaces/EnvelopeWithBatchId.md index 728389da..25308fa2 100644 --- a/docs/api/interfaces/EnvelopeWithBatchId.md +++ b/docs/api/interfaces/EnvelopeWithBatchId.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / EnvelopeWithBatchId - # Interface: EnvelopeWithBatchId Defined in: [bee-js/src/types/index.ts:579](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L579) diff --git a/docs/api/interfaces/FeedReader.md b/docs/api/interfaces/FeedReader.md index ebe264c8..648c6d53 100644 --- a/docs/api/interfaces/FeedReader.md +++ b/docs/api/interfaces/FeedReader.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / FeedReader - # Interface: FeedReader Defined in: [bee-js/src/types/index.ts:369](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L369) diff --git a/docs/api/interfaces/FeedWriter.md b/docs/api/interfaces/FeedWriter.md index a164d2ba..5a13db2d 100644 --- a/docs/api/interfaces/FeedWriter.md +++ b/docs/api/interfaces/FeedWriter.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / FeedWriter - # Interface: FeedWriter Defined in: [bee-js/src/types/index.ts:392](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L392) diff --git a/docs/api/interfaces/FileData.md b/docs/api/interfaces/FileData.md index 889add0c..ddaf2750 100644 --- a/docs/api/interfaces/FileData.md +++ b/docs/api/interfaces/FileData.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / FileData - # Interface: FileData\ Defined in: [bee-js/src/types/index.ts:273](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L273) diff --git a/docs/api/interfaces/FileHeaders.md b/docs/api/interfaces/FileHeaders.md index fb29d7fc..45c2e2d4 100644 --- a/docs/api/interfaces/FileHeaders.md +++ b/docs/api/interfaces/FileHeaders.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / FileHeaders - # Interface: FileHeaders Defined in: [bee-js/src/types/index.ts:267](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L267) diff --git a/docs/api/interfaces/FileUploadOptions.md b/docs/api/interfaces/FileUploadOptions.md index 16750f7b..a3ab850b 100644 --- a/docs/api/interfaces/FileUploadOptions.md +++ b/docs/api/interfaces/FileUploadOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / FileUploadOptions - # Interface: FileUploadOptions Defined in: [bee-js/src/types/index.ts:200](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L200) diff --git a/docs/api/interfaces/GetGranteesResult.md b/docs/api/interfaces/GetGranteesResult.md index 5d38b6a9..75c27e91 100644 --- a/docs/api/interfaces/GetGranteesResult.md +++ b/docs/api/interfaces/GetGranteesResult.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / GetGranteesResult - # Interface: GetGranteesResult Defined in: [bee-js/src/types/index.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L71) diff --git a/docs/api/interfaces/GlobalPostageBatch.md b/docs/api/interfaces/GlobalPostageBatch.md index af5f8dcc..e80101a4 100644 --- a/docs/api/interfaces/GlobalPostageBatch.md +++ b/docs/api/interfaces/GlobalPostageBatch.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / GlobalPostageBatch - # Interface: GlobalPostageBatch Defined in: [bee-js/src/types/index.ts:455](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L455) diff --git a/docs/api/interfaces/GranteesResult.md b/docs/api/interfaces/GranteesResult.md index c233b0c5..f14969e5 100644 --- a/docs/api/interfaces/GranteesResult.md +++ b/docs/api/interfaces/GranteesResult.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / GranteesResult - # Interface: GranteesResult Defined in: [bee-js/src/types/index.ts:64](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L64) diff --git a/docs/api/interfaces/GsocMessageHandler.md b/docs/api/interfaces/GsocMessageHandler.md index 64e9a020..4b3cac2e 100644 --- a/docs/api/interfaces/GsocMessageHandler.md +++ b/docs/api/interfaces/GsocMessageHandler.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / GsocMessageHandler - # Interface: GsocMessageHandler Defined in: [bee-js/src/types/index.ts:339](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L339) diff --git a/docs/api/interfaces/GsocSubscription.md b/docs/api/interfaces/GsocSubscription.md index 7d62d953..00be6adc 100644 --- a/docs/api/interfaces/GsocSubscription.md +++ b/docs/api/interfaces/GsocSubscription.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / GsocSubscription - # Interface: GsocSubscription Defined in: [bee-js/src/types/index.ts:334](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L334) diff --git a/docs/api/interfaces/Health.md b/docs/api/interfaces/Health.md index 0f55c78b..a9eefe73 100644 --- a/docs/api/interfaces/Health.md +++ b/docs/api/interfaces/Health.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Health - # Interface: Health Defined in: [bee-js/src/types/debug.ts:110](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L110) diff --git a/docs/api/interfaces/LastCashoutActionResponse.md b/docs/api/interfaces/LastCashoutActionResponse.md index 331dd806..e5545c3d 100644 --- a/docs/api/interfaces/LastCashoutActionResponse.md +++ b/docs/api/interfaces/LastCashoutActionResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / LastCashoutActionResponse - # Interface: LastCashoutActionResponse Defined in: [bee-js/src/types/debug.ts:57](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L57) diff --git a/docs/api/interfaces/LastChequesForPeerResponse.md b/docs/api/interfaces/LastChequesForPeerResponse.md index c5406bee..663ea0ec 100644 --- a/docs/api/interfaces/LastChequesForPeerResponse.md +++ b/docs/api/interfaces/LastChequesForPeerResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / LastChequesForPeerResponse - # Interface: LastChequesForPeerResponse Defined in: [bee-js/src/types/debug.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L75) diff --git a/docs/api/interfaces/LastChequesResponse.md b/docs/api/interfaces/LastChequesResponse.md index 4f924fbf..c8283b9c 100644 --- a/docs/api/interfaces/LastChequesResponse.md +++ b/docs/api/interfaces/LastChequesResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / LastChequesResponse - # Interface: LastChequesResponse Defined in: [bee-js/src/types/debug.ts:81](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L81) diff --git a/docs/api/interfaces/NodeAddresses.md b/docs/api/interfaces/NodeAddresses.md index 615c5be9..74c60cd2 100644 --- a/docs/api/interfaces/NodeAddresses.md +++ b/docs/api/interfaces/NodeAddresses.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NodeAddresses - # Interface: NodeAddresses Defined in: [bee-js/src/types/debug.ts:17](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L17) diff --git a/docs/api/interfaces/NodeInfo.md b/docs/api/interfaces/NodeInfo.md index c254b9fe..6d63f9aa 100644 --- a/docs/api/interfaces/NodeInfo.md +++ b/docs/api/interfaces/NodeInfo.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NodeInfo - # Interface: NodeInfo Defined in: [bee-js/src/types/debug.ts:172](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L172) diff --git a/docs/api/interfaces/Peer.md b/docs/api/interfaces/Peer.md index 01dfc2fd..9d5466d7 100644 --- a/docs/api/interfaces/Peer.md +++ b/docs/api/interfaces/Peer.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Peer - # Interface: Peer Defined in: [bee-js/src/types/debug.ts:25](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L25) diff --git a/docs/api/interfaces/PeerBalance.md b/docs/api/interfaces/PeerBalance.md index 7642ac13..590bb58c 100644 --- a/docs/api/interfaces/PeerBalance.md +++ b/docs/api/interfaces/PeerBalance.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PeerBalance - # Interface: PeerBalance Defined in: [bee-js/src/types/debug.ts:85](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L85) diff --git a/docs/api/interfaces/Pin.md b/docs/api/interfaces/Pin.md index d602a77d..a82cd56d 100644 --- a/docs/api/interfaces/Pin.md +++ b/docs/api/interfaces/Pin.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Pin - # Interface: Pin Defined in: [bee-js/src/types/index.ts:277](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L277) diff --git a/docs/api/interfaces/PingResponse.md b/docs/api/interfaces/PingResponse.md index 813c4084..c217d553 100644 --- a/docs/api/interfaces/PingResponse.md +++ b/docs/api/interfaces/PingResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PingResponse - # Interface: PingResponse Defined in: [bee-js/src/types/debug.ts:250](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L250) diff --git a/docs/api/interfaces/PostageBatch.md b/docs/api/interfaces/PostageBatch.md index d215200a..6f39b760 100644 --- a/docs/api/interfaces/PostageBatch.md +++ b/docs/api/interfaces/PostageBatch.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PostageBatch - # Interface: PostageBatch Defined in: [bee-js/src/types/index.ts:466](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L466) diff --git a/docs/api/interfaces/PostageBatchBuckets.md b/docs/api/interfaces/PostageBatchBuckets.md index 262c7f19..44f77683 100644 --- a/docs/api/interfaces/PostageBatchBuckets.md +++ b/docs/api/interfaces/PostageBatchBuckets.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PostageBatchBuckets - # Interface: PostageBatchBuckets Defined in: [bee-js/src/types/index.ts:515](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L515) diff --git a/docs/api/interfaces/PostageBatchOptions.md b/docs/api/interfaces/PostageBatchOptions.md index e5b350bc..506b4706 100644 --- a/docs/api/interfaces/PostageBatchOptions.md +++ b/docs/api/interfaces/PostageBatchOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PostageBatchOptions - # Interface: PostageBatchOptions Defined in: [bee-js/src/types/index.ts:537](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L537) diff --git a/docs/api/interfaces/PssMessageHandler.md b/docs/api/interfaces/PssMessageHandler.md index 14d7cee4..b8a59aa2 100644 --- a/docs/api/interfaces/PssMessageHandler.md +++ b/docs/api/interfaces/PssMessageHandler.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PssMessageHandler - # Interface: PssMessageHandler Defined in: [bee-js/src/types/index.ts:329](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L329) diff --git a/docs/api/interfaces/PssSubscription.md b/docs/api/interfaces/PssSubscription.md index 3f730f2c..b90ab517 100644 --- a/docs/api/interfaces/PssSubscription.md +++ b/docs/api/interfaces/PssSubscription.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PssSubscription - # Interface: PssSubscription Defined in: [bee-js/src/types/index.ts:324](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L324) diff --git a/docs/api/interfaces/Readiness.md b/docs/api/interfaces/Readiness.md index 024675cc..9cdfbcd1 100644 --- a/docs/api/interfaces/Readiness.md +++ b/docs/api/interfaces/Readiness.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Readiness - # Interface: Readiness Defined in: [bee-js/src/types/debug.ts:116](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L116) diff --git a/docs/api/interfaces/RedistributionState.md b/docs/api/interfaces/RedistributionState.md index 86215323..efb9f469 100644 --- a/docs/api/interfaces/RedistributionState.md +++ b/docs/api/interfaces/RedistributionState.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / RedistributionState - # Interface: RedistributionState Defined in: [bee-js/src/types/debug.ts:151](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L151) diff --git a/docs/api/interfaces/RedundantUploadOptions.md b/docs/api/interfaces/RedundantUploadOptions.md index 4f36dca6..f8b7db9c 100644 --- a/docs/api/interfaces/RedundantUploadOptions.md +++ b/docs/api/interfaces/RedundantUploadOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / RedundantUploadOptions - # Interface: RedundantUploadOptions Defined in: [bee-js/src/types/index.ts:158](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L158) diff --git a/docs/api/interfaces/ReferenceInformation.md b/docs/api/interfaces/ReferenceInformation.md index 3351f1f5..a5e68f48 100644 --- a/docs/api/interfaces/ReferenceInformation.md +++ b/docs/api/interfaces/ReferenceInformation.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / ReferenceInformation - # Interface: ReferenceInformation Defined in: [bee-js/src/types/index.ts:281](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L281) diff --git a/docs/api/interfaces/ReferenceResponse.md b/docs/api/interfaces/ReferenceResponse.md index 1b759434..a039bade 100644 --- a/docs/api/interfaces/ReferenceResponse.md +++ b/docs/api/interfaces/ReferenceResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / ReferenceResponse - # Interface: ReferenceResponse Defined in: [bee-js/src/types/index.ts:344](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L344) diff --git a/docs/api/interfaces/RemovePeerResponse.md b/docs/api/interfaces/RemovePeerResponse.md index 25fabf4b..3634cf58 100644 --- a/docs/api/interfaces/RemovePeerResponse.md +++ b/docs/api/interfaces/RemovePeerResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / RemovePeerResponse - # Interface: RemovePeerResponse Defined in: [bee-js/src/types/debug.ts:193](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L193) diff --git a/docs/api/interfaces/ReserveState.md b/docs/api/interfaces/ReserveState.md index 694f01c1..052354da 100644 --- a/docs/api/interfaces/ReserveState.md +++ b/docs/api/interfaces/ReserveState.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / ReserveState - # Interface: ReserveState Defined in: [bee-js/src/types/debug.ts:254](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L254) diff --git a/docs/api/interfaces/SOCReader.md b/docs/api/interfaces/SOCReader.md index 1cb71d84..79399d49 100644 --- a/docs/api/interfaces/SOCReader.md +++ b/docs/api/interfaces/SOCReader.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / SOCReader - # Interface: SOCReader Defined in: [bee-js/src/types/index.ts:426](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L426) diff --git a/docs/api/interfaces/SOCWriter.md b/docs/api/interfaces/SOCWriter.md index ed7c92a8..77c872e9 100644 --- a/docs/api/interfaces/SOCWriter.md +++ b/docs/api/interfaces/SOCWriter.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / SOCWriter - # Interface: SOCWriter Defined in: [bee-js/src/types/index.ts:439](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L439) diff --git a/docs/api/interfaces/Settlements.md b/docs/api/interfaces/Settlements.md index fa9eb210..a375656b 100644 --- a/docs/api/interfaces/Settlements.md +++ b/docs/api/interfaces/Settlements.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Settlements - # Interface: Settlements Defined in: [bee-js/src/types/debug.ts:5](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L5) diff --git a/docs/api/interfaces/Tag.md b/docs/api/interfaces/Tag.md index a605e061..0468ddd4 100644 --- a/docs/api/interfaces/Tag.md +++ b/docs/api/interfaces/Tag.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Tag - # Interface: Tag Defined in: [bee-js/src/types/index.ts:251](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L251) diff --git a/docs/api/interfaces/Topology.md b/docs/api/interfaces/Topology.md index 903e45e2..25fbb5fa 100644 --- a/docs/api/interfaces/Topology.md +++ b/docs/api/interfaces/Topology.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Topology - # Interface: Topology Defined in: [bee-js/src/types/debug.ts:205](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L205) diff --git a/docs/api/interfaces/TransactionInfo.md b/docs/api/interfaces/TransactionInfo.md index 467917ea..b615c5ba 100644 --- a/docs/api/interfaces/TransactionInfo.md +++ b/docs/api/interfaces/TransactionInfo.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / TransactionInfo - # Interface: TransactionInfo Defined in: [bee-js/src/types/index.ts:522](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L522) diff --git a/docs/api/interfaces/TransactionOptions.md b/docs/api/interfaces/TransactionOptions.md index 4392a68b..dbc759f1 100644 --- a/docs/api/interfaces/TransactionOptions.md +++ b/docs/api/interfaces/TransactionOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / TransactionOptions - # Interface: TransactionOptions Defined in: [bee-js/src/types/debug.ts:39](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L39) diff --git a/docs/api/interfaces/TransactionResponse.md b/docs/api/interfaces/TransactionResponse.md index 7e25846e..c0b84111 100644 --- a/docs/api/interfaces/TransactionResponse.md +++ b/docs/api/interfaces/TransactionResponse.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / TransactionResponse - # Interface: TransactionResponse Defined in: [bee-js/src/types/debug.ts:65](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L65) diff --git a/docs/api/interfaces/UploadHeaders.md b/docs/api/interfaces/UploadHeaders.md index bea0c849..30ae41d8 100644 --- a/docs/api/interfaces/UploadHeaders.md +++ b/docs/api/interfaces/UploadHeaders.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / UploadHeaders - # Interface: UploadHeaders Defined in: [bee-js/src/types/index.ts:238](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L238) diff --git a/docs/api/interfaces/UploadOptions.md b/docs/api/interfaces/UploadOptions.md index 9467fd36..749092dc 100644 --- a/docs/api/interfaces/UploadOptions.md +++ b/docs/api/interfaces/UploadOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / UploadOptions - # Interface: UploadOptions Defined in: [bee-js/src/types/index.ts:97](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L97) diff --git a/docs/api/interfaces/UploadResult.md b/docs/api/interfaces/UploadResult.md index 8726e78d..b119e4bb 100644 --- a/docs/api/interfaces/UploadResult.md +++ b/docs/api/interfaces/UploadResult.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / UploadResult - # Interface: UploadResult Defined in: [bee-js/src/types/index.ts:80](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/index.ts#L80) diff --git a/docs/api/interfaces/WalletBalance.md b/docs/api/interfaces/WalletBalance.md index c2c7b436..8e6df99a 100644 --- a/docs/api/interfaces/WalletBalance.md +++ b/docs/api/interfaces/WalletBalance.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / WalletBalance - # Interface: WalletBalance Defined in: [bee-js/src/types/debug.ts:267](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/types/debug.ts#L267) diff --git a/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md b/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md index 53e6ad19..32997249 100644 --- a/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md +++ b/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / approximateOverheadForRedundancyLevel # Function: approximateOverheadForRedundancyLevel() diff --git a/docs/api/namespaces/Utils/getAmountForDuration.md b/docs/api/namespaces/Utils/getAmountForDuration.md index e9ba8e55..3d7e945e 100644 --- a/docs/api/namespaces/Utils/getAmountForDuration.md +++ b/docs/api/namespaces/Utils/getAmountForDuration.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getAmountForDuration # Function: getAmountForDuration() diff --git a/docs/api/namespaces/Utils/getCollectionSize.md b/docs/api/namespaces/Utils/getCollectionSize.md index 35f06da7..e2cefdff 100644 --- a/docs/api/namespaces/Utils/getCollectionSize.md +++ b/docs/api/namespaces/Utils/getCollectionSize.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getCollectionSize # Function: getCollectionSize() diff --git a/docs/api/namespaces/Utils/getDepthForSize.md b/docs/api/namespaces/Utils/getDepthForSize.md index c2c7fa8d..a79dbe2d 100644 --- a/docs/api/namespaces/Utils/getDepthForSize.md +++ b/docs/api/namespaces/Utils/getDepthForSize.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getDepthForSize # Function: getDepthForSize() diff --git a/docs/api/namespaces/Utils/getFolderSize.md b/docs/api/namespaces/Utils/getFolderSize.md index 51473517..9d75ced7 100644 --- a/docs/api/namespaces/Utils/getFolderSize.md +++ b/docs/api/namespaces/Utils/getFolderSize.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getFolderSize # Function: getFolderSize() diff --git a/docs/api/namespaces/Utils/getRedundancyStat.md b/docs/api/namespaces/Utils/getRedundancyStat.md index 895c46c2..75cdaa2c 100644 --- a/docs/api/namespaces/Utils/getRedundancyStat.md +++ b/docs/api/namespaces/Utils/getRedundancyStat.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getRedundancyStat # Function: getRedundancyStat() diff --git a/docs/api/namespaces/Utils/getRedundancyStats.md b/docs/api/namespaces/Utils/getRedundancyStats.md index 9a7dc867..4ab30d5d 100644 --- a/docs/api/namespaces/Utils/getRedundancyStats.md +++ b/docs/api/namespaces/Utils/getRedundancyStats.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getRedundancyStats # Function: getRedundancyStats() diff --git a/docs/api/namespaces/Utils/getStampCost.md b/docs/api/namespaces/Utils/getStampCost.md index 0fea9020..e321175c 100644 --- a/docs/api/namespaces/Utils/getStampCost.md +++ b/docs/api/namespaces/Utils/getStampCost.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getStampCost # Function: getStampCost() diff --git a/docs/api/namespaces/Utils/getStampDuration.md b/docs/api/namespaces/Utils/getStampDuration.md index 57637d3b..ef4e5b25 100644 --- a/docs/api/namespaces/Utils/getStampDuration.md +++ b/docs/api/namespaces/Utils/getStampDuration.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getStampDuration # Function: getStampDuration() diff --git a/docs/api/namespaces/Utils/getStampEffectiveBytes.md b/docs/api/namespaces/Utils/getStampEffectiveBytes.md index d66c5010..a792297b 100644 --- a/docs/api/namespaces/Utils/getStampEffectiveBytes.md +++ b/docs/api/namespaces/Utils/getStampEffectiveBytes.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getStampEffectiveBytes # Function: getStampEffectiveBytes() diff --git a/docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md b/docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md index de12ee9f..a40d9bec 100644 --- a/docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md +++ b/docs/api/namespaces/Utils/getStampEffectiveBytesBreakpoints.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getStampEffectiveBytesBreakpoints # Function: getStampEffectiveBytesBreakpoints() diff --git a/docs/api/namespaces/Utils/getStampTheoreticalBytes.md b/docs/api/namespaces/Utils/getStampTheoreticalBytes.md index f0c374fe..2d9a5875 100644 --- a/docs/api/namespaces/Utils/getStampTheoreticalBytes.md +++ b/docs/api/namespaces/Utils/getStampTheoreticalBytes.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getStampTheoreticalBytes # Function: getStampTheoreticalBytes() diff --git a/docs/api/namespaces/Utils/getStampUsage.md b/docs/api/namespaces/Utils/getStampUsage.md index 1e545d2c..3e0429c0 100644 --- a/docs/api/namespaces/Utils/getStampUsage.md +++ b/docs/api/namespaces/Utils/getStampUsage.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / getStampUsage # Function: getStampUsage() diff --git a/docs/api/namespaces/Utils/makeCollectionFromFileList.md b/docs/api/namespaces/Utils/makeCollectionFromFileList.md index 0dd34b18..7c5d6041 100644 --- a/docs/api/namespaces/Utils/makeCollectionFromFileList.md +++ b/docs/api/namespaces/Utils/makeCollectionFromFileList.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / makeCollectionFromFileList # Function: makeCollectionFromFileList() diff --git a/docs/api/namespaces/Utils/makeMaxTarget.md b/docs/api/namespaces/Utils/makeMaxTarget.md index bab376f9..fb966f77 100644 --- a/docs/api/namespaces/Utils/makeMaxTarget.md +++ b/docs/api/namespaces/Utils/makeMaxTarget.md @@ -1,7 +1,3 @@ -[**@ethersphere/bee-js**] - -*** - [@ethersphere/bee-js] / [Utils] / makeMaxTarget # Function: makeMaxTarget() diff --git a/docs/api/type-aliases/BeeRequestOptions.md b/docs/api/type-aliases/BeeRequestOptions.md index e7cf8ce6..e447e1ae 100644 --- a/docs/api/type-aliases/BeeRequestOptions.md +++ b/docs/api/type-aliases/BeeRequestOptions.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BeeRequestOptions - # Type Alias: BeeRequestOptions > **BeeRequestOptions** = `object` diff --git a/docs/api/type-aliases/Collection.md b/docs/api/type-aliases/Collection.md index c425d552..7e113a54 100644 --- a/docs/api/type-aliases/Collection.md +++ b/docs/api/type-aliases/Collection.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / Collection - # Type Alias: Collection > **Collection** = [`CollectionEntry`](../interfaces/CollectionEntry.md)[] diff --git a/docs/api/type-aliases/HookCallback.md b/docs/api/type-aliases/HookCallback.md index bc3756b8..f2f63a36 100644 --- a/docs/api/type-aliases/HookCallback.md +++ b/docs/api/type-aliases/HookCallback.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / HookCallback - # Type Alias: HookCallback()\ > **HookCallback**\<`V`\> = (`value`) => `void` \| `Promise`\<`void`\> diff --git a/docs/api/type-aliases/HttpMethod.md b/docs/api/type-aliases/HttpMethod.md index 570bea12..a5c44b1e 100644 --- a/docs/api/type-aliases/HttpMethod.md +++ b/docs/api/type-aliases/HttpMethod.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / HttpMethod - # Type Alias: HttpMethod > **HttpMethod** = `"GET"` \| `"DELETE"` \| `"POST"` \| `"PATCH"` \| `"PUT"` diff --git a/docs/api/type-aliases/NumberString.md b/docs/api/type-aliases/NumberString.md index 4b74b47a..91b73f6f 100644 --- a/docs/api/type-aliases/NumberString.md +++ b/docs/api/type-aliases/NumberString.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NumberString - # Type Alias: NumberString > **NumberString** = `string` & `object` diff --git a/docs/api/variables/BRANCHES.md b/docs/api/variables/BRANCHES.md index c964bf25..d7f014e0 100644 --- a/docs/api/variables/BRANCHES.md +++ b/docs/api/variables/BRANCHES.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / BRANCHES - # Variable: BRANCHES > `const` **BRANCHES**: `128` = `128` diff --git a/docs/api/variables/CHUNK_SIZE.md b/docs/api/variables/CHUNK_SIZE.md index 954c5b30..9d3f878c 100644 --- a/docs/api/variables/CHUNK_SIZE.md +++ b/docs/api/variables/CHUNK_SIZE.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / CHUNK\_SIZE - # Variable: CHUNK\_SIZE > `const` **CHUNK\_SIZE**: `number` diff --git a/docs/api/variables/FEED_INDEX_HEX_LENGTH.md b/docs/api/variables/FEED_INDEX_HEX_LENGTH.md index cef35785..719eaa65 100644 --- a/docs/api/variables/FEED_INDEX_HEX_LENGTH.md +++ b/docs/api/variables/FEED_INDEX_HEX_LENGTH.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / FEED\_INDEX\_HEX\_LENGTH - # Variable: FEED\_INDEX\_HEX\_LENGTH > `const` **FEED\_INDEX\_HEX\_LENGTH**: `16` = `16` diff --git a/docs/api/variables/NULL_ADDRESS.md b/docs/api/variables/NULL_ADDRESS.md index f6074fbf..0d176bad 100644 --- a/docs/api/variables/NULL_ADDRESS.md +++ b/docs/api/variables/NULL_ADDRESS.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NULL\_ADDRESS - # Variable: NULL\_ADDRESS > `const` **NULL\_ADDRESS**: `Uint8Array`\<`ArrayBuffer`\> diff --git a/docs/api/variables/NULL_IDENTIFIER.md b/docs/api/variables/NULL_IDENTIFIER.md index 146a11db..6d8bee44 100644 --- a/docs/api/variables/NULL_IDENTIFIER.md +++ b/docs/api/variables/NULL_IDENTIFIER.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NULL\_IDENTIFIER - # Variable: NULL\_IDENTIFIER > `const` **NULL\_IDENTIFIER**: `Uint8Array`\<`ArrayBuffer`\> diff --git a/docs/api/variables/NULL_OWNER.md b/docs/api/variables/NULL_OWNER.md index 1c2954a3..f9c545c7 100644 --- a/docs/api/variables/NULL_OWNER.md +++ b/docs/api/variables/NULL_OWNER.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NULL\_OWNER - # Variable: NULL\_OWNER > `const` **NULL\_OWNER**: `Uint8Array`\<`ArrayBuffer`\> diff --git a/docs/api/variables/NULL_STAMP.md b/docs/api/variables/NULL_STAMP.md index c0d19c02..def5582b 100644 --- a/docs/api/variables/NULL_STAMP.md +++ b/docs/api/variables/NULL_STAMP.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NULL\_STAMP - # Variable: NULL\_STAMP > `const` **NULL\_STAMP**: [`BatchId`](../classes/BatchId.md) diff --git a/docs/api/variables/NULL_TOPIC.md b/docs/api/variables/NULL_TOPIC.md index 59a9a463..74d9e56e 100644 --- a/docs/api/variables/NULL_TOPIC.md +++ b/docs/api/variables/NULL_TOPIC.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / NULL\_TOPIC - # Variable: NULL\_TOPIC > `const` **NULL\_TOPIC**: [`Topic`](../classes/Topic.md) diff --git a/docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md b/docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md index 03cbc2e2..7ccbe704 100644 --- a/docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md +++ b/docs/api/variables/PSS_TARGET_HEX_LENGTH_MAX.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / PSS\_TARGET\_HEX\_LENGTH\_MAX - # Variable: PSS\_TARGET\_HEX\_LENGTH\_MAX > `const` **PSS\_TARGET\_HEX\_LENGTH\_MAX**: `4` = `4` diff --git a/docs/api/variables/SECTION_SIZE.md b/docs/api/variables/SECTION_SIZE.md index 651bf93e..7d7c7161 100644 --- a/docs/api/variables/SECTION_SIZE.md +++ b/docs/api/variables/SECTION_SIZE.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / SECTION\_SIZE - # Variable: SECTION\_SIZE > `const` **SECTION\_SIZE**: `32` = `32` diff --git a/docs/api/variables/STAMPS_DEPTH_MAX.md b/docs/api/variables/STAMPS_DEPTH_MAX.md index d6f0b5e9..8ae81159 100644 --- a/docs/api/variables/STAMPS_DEPTH_MAX.md +++ b/docs/api/variables/STAMPS_DEPTH_MAX.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / STAMPS\_DEPTH\_MAX - # Variable: STAMPS\_DEPTH\_MAX > `const` **STAMPS\_DEPTH\_MAX**: `255` = `255` diff --git a/docs/api/variables/STAMPS_DEPTH_MIN.md b/docs/api/variables/STAMPS_DEPTH_MIN.md index bc6f8eea..4b96989c 100644 --- a/docs/api/variables/STAMPS_DEPTH_MIN.md +++ b/docs/api/variables/STAMPS_DEPTH_MIN.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / STAMPS\_DEPTH\_MIN - # Variable: STAMPS\_DEPTH\_MIN > `const` **STAMPS\_DEPTH\_MIN**: `17` = `17` diff --git a/docs/api/variables/SUPPORTED_BEE_VERSION.md b/docs/api/variables/SUPPORTED_BEE_VERSION.md index 6b4ed674..00952d29 100644 --- a/docs/api/variables/SUPPORTED_BEE_VERSION.md +++ b/docs/api/variables/SUPPORTED_BEE_VERSION.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / SUPPORTED\_BEE\_VERSION - # Variable: SUPPORTED\_BEE\_VERSION > `const` **SUPPORTED\_BEE\_VERSION**: `string` diff --git a/docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md b/docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md index d3bc237d..da622494 100644 --- a/docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md +++ b/docs/api/variables/SUPPORTED_BEE_VERSION_EXACT.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / SUPPORTED\_BEE\_VERSION\_EXACT - # Variable: SUPPORTED\_BEE\_VERSION\_EXACT > `const` **SUPPORTED\_BEE\_VERSION\_EXACT**: `"2.4.0-390a402e"` = `'2.4.0-390a402e'` diff --git a/docs/api/variables/SWARM_GATEWAY_URL.md b/docs/api/variables/SWARM_GATEWAY_URL.md index 1ffdb302..6a42b194 100644 --- a/docs/api/variables/SWARM_GATEWAY_URL.md +++ b/docs/api/variables/SWARM_GATEWAY_URL.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / SWARM\_GATEWAY\_URL - # Variable: SWARM\_GATEWAY\_URL > `const` **SWARM\_GATEWAY\_URL**: `"https://api.gateway.ethswarm.org"` = `'https://api.gateway.ethswarm.org'` diff --git a/docs/api/variables/TAGS_LIMIT_MAX.md b/docs/api/variables/TAGS_LIMIT_MAX.md index 366001c0..63abd421 100644 --- a/docs/api/variables/TAGS_LIMIT_MAX.md +++ b/docs/api/variables/TAGS_LIMIT_MAX.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / TAGS\_LIMIT\_MAX - # Variable: TAGS\_LIMIT\_MAX > `const` **TAGS\_LIMIT\_MAX**: `1000` = `1000` diff --git a/docs/api/variables/TAGS_LIMIT_MIN.md b/docs/api/variables/TAGS_LIMIT_MIN.md index 11c12c33..714cae51 100644 --- a/docs/api/variables/TAGS_LIMIT_MIN.md +++ b/docs/api/variables/TAGS_LIMIT_MIN.md @@ -1,9 +1,3 @@ -[**@ethersphere/bee-js**](../Overview.md) - -*** - -[@ethersphere/bee-js](../Overview.md) / TAGS\_LIMIT\_MIN - # Variable: TAGS\_LIMIT\_MIN > `const` **TAGS\_LIMIT\_MIN**: `1` = `1` From 952c9b99186b1358c465bd925ff758ac93fc9288 Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 14:52:34 +0700 Subject: [PATCH 7/8] fix frontmatter --- docs/api/Overview.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/api/Overview.md b/docs/api/Overview.md index 0f5f7d8b..8f53cf9a 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,14 +1,10 @@ +--- +id: Overview title: API Reference slug: /api/ sidebar_position: 0 --- -**@ethersphere/bee-js** - -*** - -# @ethersphere/bee-js - ## Namespaces - [Utils](/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel) From ba8c6d94e178e4d9bf12c5b01959a5e43f32f6cb Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 22 May 2025 16:06:57 +0700 Subject: [PATCH 8/8] change title --- docs/api/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/Overview.md b/docs/api/Overview.md index 8f53cf9a..61540493 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,6 +1,6 @@ --- id: Overview -title: API Reference +title: Overview slug: /api/ sidebar_position: 0 ---