Skip to content

Commit 2e5e8de

Browse files
feat: update api reference to v0.5.0 (#17)
* feat: added generated docs for v0.5.0 * feat: added sidebar navigation * fix: relative links and titles
1 parent 7a65fc2 commit 2e5e8de

32 files changed

+3502
-203
lines changed

docs/api-reference/api-reference.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,52 @@ sidebar_label: Overview
77

88
Here are the links to our auto-generated API documentation.
99

10+
### Namespaces
11+
12+
- [Utils.Bytes](./modules/utils.bytes.md)
13+
- [Utils.Data](./modules/utils.data.md)
14+
- [Utils.Files](./modules/utils.file.md)
15+
- [Utils.Hex](./modules/utils.hex.md)
16+
- [Utils.Tar](./modules/utils.tar.md)
17+
1018
### Classes
1119

12-
- [Bee](./api-reference/classes/bee)
13-
- [BeeDebug](./api-reference/classes/beedebug)
20+
- [Bee](./classes/bee.md)
21+
- [BeeArgumentError](./classes/beeargumenterror.md)
22+
- [BeeDebug](./classes/beedebug.md)
23+
- [BeeError](./classes/beeerror.md)
24+
- [BeeRequestError](./classes/beerequesterror.md)
25+
- [BeeResponseError](./classes/beeresponseerror.md)
26+
27+
### Interfaces
28+
29+
- [BeeResponse](./interfaces/beeresponse.md)
30+
- [CollectionEntry](./interfaces/collectionentry.md)
31+
- [CollectionUploadOptions](./interfaces/collectionuploadoptions.md)
32+
- [Dictionary](./interfaces/dictionary.md)
33+
- [DownloadOptions](./interfaces/downloadoptions.md)
34+
- [FileData](./interfaces/filedata.md)
35+
- [FileHeaders](./interfaces/fileheaders.md)
36+
- [FileUploadOptions](./interfaces/fileuploadoptions.md)
37+
- [PssMessageHandler](./interfaces/pssmessagehandler.md)
38+
- [PssSubscription](./interfaces/psssubscription.md)
39+
- [ReferenceResponse](./interfaces/referenceresponse.md)
40+
- [Tag](./interfaces/tag.md)
41+
- [UploadHeaders](./interfaces/uploadheaders.md)
42+
- [UploadOptions](./interfaces/uploadoptions.md)
43+
44+
### Type aliases
45+
46+
- [Address](./typealiases/typealiases.md#address)
47+
- [AddressPrefix](./typealiases/typealiases.md#addressprefix)
48+
- [BrandedString](./typealiases/typealiases.md#brandedstring)
49+
- [BrandedType](./typealiases/typealiases.md#brandedtype)
50+
- [Collection](./typealiases/typealiases.md#collection)
51+
- [FlavoredType](./typealiases/typealiases.md#flavoredtype)
52+
- [PublicKey](./typealiases/typealiases.md#publickey)
53+
- [Reference](./typealiases/typealiases.md#reference)
1454

15-
### default
55+
### Variables
1656

17-
Renames and exports: [Bee](./api-reference/classes/bee)
57+
- [ENCRYPTED\_REFERENCE\_LENGTH](./variables/variables.md#encrypted_reference_length)
58+
- [REFERENCE\_LENGTH](./variables/variables.md#reference_length)

0 commit comments

Comments
 (0)