Typedoc

docs/api/Overview.md

@@ -0,0 +1,143 @@
+---
+id: Overview
+title: API Reference
+slug: /api/
+sidebar_position: 0
+---
+
+## 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)