Skip to content

Commit 6cf2e3b

Browse files
authored
Typedoc (#240)
* typedoc docs * update header sizes * update overview frontmatter * update slug * reduce header sizes * remove breadcrumbs * fix frontmatter
1 parent 0465fac commit 6cf2e3b

File tree

133 files changed

+16735
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+16735
-0
lines changed

docs/api/Overview.md

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
id: Overview
3+
title: API Reference
4+
slug: /api/
5+
sidebar_position: 0
6+
---
7+
8+
## Namespaces
9+
10+
- [Utils](/docs/api/namespaces/Utils/approximateOverheadForRedundancyLevel)
11+
12+
## Enumerations
13+
14+
- [BeeModes](enumerations/BeeModes.md)
15+
- [RedundancyLevel](enumerations/RedundancyLevel.md)
16+
- [RedundancyStrategy](enumerations/RedundancyStrategy.md)
17+
18+
## Classes
19+
20+
- [BatchId](classes/BatchId.md)
21+
- [Bee](classes/Bee.md)
22+
- [BeeArgumentError](classes/BeeArgumentError.md)
23+
- [BeeDev](classes/BeeDev.md)
24+
- [BeeError](classes/BeeError.md)
25+
- [BeeResponseError](classes/BeeResponseError.md)
26+
- [Bytes](classes/Bytes.md)
27+
- [BZZ](classes/BZZ.md)
28+
- [DAI](classes/DAI.md)
29+
- [Duration](classes/Duration.md)
30+
- [EthAddress](classes/EthAddress.md)
31+
- [FeedIndex](classes/FeedIndex.md)
32+
- [Identifier](classes/Identifier.md)
33+
- [MantarayNode](classes/MantarayNode.md)
34+
- [PeerAddress](classes/PeerAddress.md)
35+
- [PrivateKey](classes/PrivateKey.md)
36+
- [PublicKey](classes/PublicKey.md)
37+
- [Reference](classes/Reference.md)
38+
- [Signature](classes/Signature.md)
39+
- [Size](classes/Size.md)
40+
- [Span](classes/Span.md)
41+
- [Stamper](classes/Stamper.md)
42+
- [Topic](classes/Topic.md)
43+
- [TransactionId](classes/TransactionId.md)
44+
45+
## Interfaces
46+
47+
- [AllSettlements](interfaces/AllSettlements.md)
48+
- [AllTagsOptions](interfaces/AllTagsOptions.md)
49+
- [BalanceResponse](interfaces/BalanceResponse.md)
50+
- [BatchBucket](interfaces/BatchBucket.md)
51+
- [BeeOptions](interfaces/BeeOptions.md)
52+
- [BeeRequest](interfaces/BeeRequest.md)
53+
- [BeeResponse](interfaces/BeeResponse.md)
54+
- [BeeVersions](interfaces/BeeVersions.md)
55+
- [Bin](interfaces/Bin.md)
56+
- [CashoutResult](interfaces/CashoutResult.md)
57+
- [ChainState](interfaces/ChainState.md)
58+
- [Cheque](interfaces/Cheque.md)
59+
- [ChequebookAddressResponse](interfaces/ChequebookAddressResponse.md)
60+
- [ChequebookBalanceResponse](interfaces/ChequebookBalanceResponse.md)
61+
- [CollectionEntry](interfaces/CollectionEntry.md)
62+
- [CollectionUploadOptions](interfaces/CollectionUploadOptions.md)
63+
- [Data](interfaces/Data.md)
64+
- [DebugStatus](interfaces/DebugStatus.md)
65+
- [DownloadOptions](interfaces/DownloadOptions.md)
66+
- [Envelope](interfaces/Envelope.md)
67+
- [EnvelopeWithBatchId](interfaces/EnvelopeWithBatchId.md)
68+
- [FeedReader](interfaces/FeedReader.md)
69+
- [FeedWriter](interfaces/FeedWriter.md)
70+
- [FileData](interfaces/FileData.md)
71+
- [FileHeaders](interfaces/FileHeaders.md)
72+
- [FileUploadOptions](interfaces/FileUploadOptions.md)
73+
- [GetGranteesResult](interfaces/GetGranteesResult.md)
74+
- [GlobalPostageBatch](interfaces/GlobalPostageBatch.md)
75+
- [GranteesResult](interfaces/GranteesResult.md)
76+
- [GsocMessageHandler](interfaces/GsocMessageHandler.md)
77+
- [GsocSubscription](interfaces/GsocSubscription.md)
78+
- [Health](interfaces/Health.md)
79+
- [LastCashoutActionResponse](interfaces/LastCashoutActionResponse.md)
80+
- [LastChequesForPeerResponse](interfaces/LastChequesForPeerResponse.md)
81+
- [LastChequesResponse](interfaces/LastChequesResponse.md)
82+
- [NodeAddresses](interfaces/NodeAddresses.md)
83+
- [NodeInfo](interfaces/NodeInfo.md)
84+
- [Peer](interfaces/Peer.md)
85+
- [PeerBalance](interfaces/PeerBalance.md)
86+
- [Pin](interfaces/Pin.md)
87+
- [PingResponse](interfaces/PingResponse.md)
88+
- [PostageBatch](interfaces/PostageBatch.md)
89+
- [PostageBatchBuckets](interfaces/PostageBatchBuckets.md)
90+
- [PostageBatchOptions](interfaces/PostageBatchOptions.md)
91+
- [PssMessageHandler](interfaces/PssMessageHandler.md)
92+
- [PssSubscription](interfaces/PssSubscription.md)
93+
- [Readiness](interfaces/Readiness.md)
94+
- [RedistributionState](interfaces/RedistributionState.md)
95+
- [RedundantUploadOptions](interfaces/RedundantUploadOptions.md)
96+
- [ReferenceInformation](interfaces/ReferenceInformation.md)
97+
- [ReferenceResponse](interfaces/ReferenceResponse.md)
98+
- [RemovePeerResponse](interfaces/RemovePeerResponse.md)
99+
- [ReserveState](interfaces/ReserveState.md)
100+
- [Settlements](interfaces/Settlements.md)
101+
- [SOCReader](interfaces/SOCReader.md)
102+
- [SOCWriter](interfaces/SOCWriter.md)
103+
- [Tag](interfaces/Tag.md)
104+
- [Topology](interfaces/Topology.md)
105+
- [TransactionInfo](interfaces/TransactionInfo.md)
106+
- [TransactionOptions](interfaces/TransactionOptions.md)
107+
- [TransactionResponse](interfaces/TransactionResponse.md)
108+
- [UploadHeaders](interfaces/UploadHeaders.md)
109+
- [UploadOptions](interfaces/UploadOptions.md)
110+
- [UploadResult](interfaces/UploadResult.md)
111+
- [WalletBalance](interfaces/WalletBalance.md)
112+
113+
## Type Aliases
114+
115+
- [BeeRequestOptions](type-aliases/BeeRequestOptions.md)
116+
- [Collection](type-aliases/Collection.md)
117+
- [HookCallback](type-aliases/HookCallback.md)
118+
- [HttpMethod](type-aliases/HttpMethod.md)
119+
- [NumberString](type-aliases/NumberString.md)
120+
121+
## Variables
122+
123+
- [BRANCHES](variables/BRANCHES.md)
124+
- [CHUNK\_SIZE](variables/CHUNK_SIZE.md)
125+
- [FEED\_INDEX\_HEX\_LENGTH](variables/FEED_INDEX_HEX_LENGTH.md)
126+
- [NULL\_ADDRESS](variables/NULL_ADDRESS.md)
127+
- [NULL\_IDENTIFIER](variables/NULL_IDENTIFIER.md)
128+
- [NULL\_OWNER](variables/NULL_OWNER.md)
129+
- [NULL\_STAMP](variables/NULL_STAMP.md)
130+
- [NULL\_TOPIC](variables/NULL_TOPIC.md)
131+
- [PSS\_TARGET\_HEX\_LENGTH\_MAX](variables/PSS_TARGET_HEX_LENGTH_MAX.md)
132+
- [SECTION\_SIZE](variables/SECTION_SIZE.md)
133+
- [STAMPS\_DEPTH\_MAX](variables/STAMPS_DEPTH_MAX.md)
134+
- [STAMPS\_DEPTH\_MIN](variables/STAMPS_DEPTH_MIN.md)
135+
- [SUPPORTED\_BEE\_VERSION](variables/SUPPORTED_BEE_VERSION.md)
136+
- [SUPPORTED\_BEE\_VERSION\_EXACT](variables/SUPPORTED_BEE_VERSION_EXACT.md)
137+
- [SWARM\_GATEWAY\_URL](variables/SWARM_GATEWAY_URL.md)
138+
- [TAGS\_LIMIT\_MAX](variables/TAGS_LIMIT_MAX.md)
139+
- [TAGS\_LIMIT\_MIN](variables/TAGS_LIMIT_MIN.md)
140+
141+
## Functions
142+
143+
- [toBeeMode](functions/toBeeMode.md)

0 commit comments

Comments
 (0)