Skip to content

Commit ef47f47

Browse files
authored
fix: deps update (#107)
1 parent 0f6f127 commit ef47f47

File tree

5 files changed

+6992
-10386
lines changed

5 files changed

+6992
-10386
lines changed

docs/user-documentation/soc-and-feeds.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,19 @@ const data = soc.payload()
3636

3737
### Writing SOCs
3838

39-
When writing a SOC, first, we need to make a writer object. Because we need to sign the chunk, we need to pass in a `signer` object. The `signer` object can be either an Ethereum private key (as a hex string or `Uint8Array`) or an instance of the [`Signer`](../api/types/signer.md) interface. The `Signer` interface can be used for integration with 3rd party Ethereum wallet applications because Swarm uses the same format for signing chunks that Ethereum uses for signing transactions.
39+
When writing a SOC, first, we need to make a writer object. Because we need to sign the chunk, we need to pass in a `signer` object. The `signer` object can be either an Ethereum private key (as a hex string or `Uint8Array`) or an instance of the [`Signer`](../api/types/Signer.md) interface. The `Signer` interface can be used for integration with 3rd party Ethereum wallet applications because Swarm uses the same format for signing chunks that Ethereum uses for signing transactions.
4040

4141
:::info Default `signer`
4242

4343
When you are instantiating `Bee` class you can pass it a default signer that will be used if you won't specify it
44-
directly for the `makeSOCWriter`. See [`Bee` constructor](../api/classes/bee.md#constructor) for more info.
44+
directly for the `makeSOCWriter`. See [`Bee` constructor](../api/classes/Bee.md#constructor) for more info.
4545

4646
:::
4747

4848
:::tip Ethereum Wallet signers
4949

50-
If you want to use your browser Ethereum Wallet like Metamask you can use utility called [`makeEthereumWalletSigner`](../api/functions/utils.makeethereumwalletsigner.md) that we ship with bee-js
51-
which creates a [`Signer`](../api/types/signer.md) object out of given EIP-1193 compatible provider.
50+
If you want to use your browser Ethereum Wallet like Metamask you can use utility called [`makeEthereumWalletSigner`](../api/functions/Utils.makeEthereumWalletSigner.md) that we ship with bee-js
51+
which creates a [`Signer`](../api/types/Signer.md) object out of given EIP-1193 compatible provider.
5252

5353
See it used in our example [here](https://github.com/ethersphere/examples-js/tree/master/eth-wallet-signing).
5454

@@ -119,11 +119,11 @@ const topic = bee.makeFeedTopic('my-dapp.eth/outbox')
119119
Many applications are storing or manipulating data in JSON. bee-js has convenience high level API to use feeds with JSON objects.
120120
It consists of two methods:
121121

122-
- [`setJsonFeed`](../api/classes/bee.md#setjsonfeed) method to set JSON compatible data to feed
123-
- [`getJsonFeed`](../api/classes/bee.md#getjsonfeed) method to get JSON compatible data (and parse them) from feed
122+
- [`setJsonFeed`](../api/classes/Bee.md#setjsonfeed) method to set JSON compatible data to feed
123+
- [`getJsonFeed`](../api/classes/Bee.md#getjsonfeed) method to get JSON compatible data (and parse them) from feed
124124

125125
:::info Bee's instance signer
126-
You can pass a [`Signer`](../api/types/signer.md) (or compatible data) into [`Bee` class constructor](../api/classes/bee.md#constructor), which then
126+
You can pass a [`Signer`](../api/types/Signer.md) (or compatible data) into [`Bee` class constructor](../api/classes/Bee.md#constructor), which then
127127
will be used as default `Signer`.
128128
:::
129129

docs/user-documentation/upload-download.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ To understand better what does it mean see [Bee docs - Keep your data alive](htt
2222

2323
### Data
2424

25-
You can upload and retrieve any `string` or `Uint8Array` data with [`uploadData`](../api/classes/bee.md#uploaddata) and [`downloadData`](../api/classes/bee.md#downloaddata) functions.
25+
You can upload and retrieve any `string` or `Uint8Array` data with [`uploadData`](../api/classes/Bee.md#uploaddata) and [`downloadData`](../api/classes/Bee.md#downloaddata) functions.
2626

27-
When you download data the return type is [`Data`](../api/interfaces/data.md) interface which extends `Uint8Array` with convenience functions like:
27+
When you download data the return type is [`Data`](../api/interfaces/Data.md) interface which extends `Uint8Array` with convenience functions like:
2828

2929
- `text()` that converts the bytes into UTF-8 encoded string
3030
- `hex()` that converts the bytes into **non-prefixed** hex string
@@ -61,7 +61,7 @@ console.log(retrievedFile.contentType) // prints 'application/octet-stream'
6161
console.log(retrievedFile.data.text()) // prints 'Bee is awesome!'
6262
```
6363

64-
In browsers, you can upload directly `File` type. The filename is taken from the file object itself, but can be overwritten through the second argument of the `uploadFile` function (see the [API docs](../api/classes/bee.md#uploadfile))
64+
In browsers, you can upload directly `File` type. The filename is taken from the file object itself, but can be overwritten through the second argument of the `uploadFile` function (see the [API docs](../api/classes/Bee.md#uploadfile))
6565

6666
```js
6767
const file = new File(["foo"], "foo.txt", { type: "text/plain" })

docusaurus.config.js

Lines changed: 55 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,96 @@
11
module.exports = {
2-
title: 'Bee JS Library',
3-
tagline: 'Welcome to the Swarm',
2+
title: "Bee JS Library",
3+
tagline: "Welcome to the Swarm",
44
// note! we use SED to change this during automated builds, see ./.github/workflows/gh-pages.yml
5-
url: 'https://bee-js.ethswarm.org',
6-
baseUrl: '/',
5+
url: "https://bee-js.ethswarm.org",
6+
baseUrl: "/",
77
trailingSlash: true,
88
plugins: [
9-
require.resolve('docusaurus-lunr-search'),
9+
require.resolve("docusaurus-lunr-search"),
1010
[
11-
'docusaurus-plugin-typedoc',
11+
"docusaurus-plugin-typedoc",
1212
{
1313
sidebar: {
14-
sidebarFile: null
15-
}
16-
}
17-
]
14+
sidebarFile: null,
15+
},
16+
},
17+
],
1818
],
19-
onBrokenLinks: 'error',
20-
onBrokenMarkdownLinks: 'error',
21-
onDuplicateRoutes: 'error',
22-
favicon: 'img/favicon.ico',
23-
organizationName: 'Swarm', // Usually your GitHub org/user name.
24-
projectName: 'bee-js-docs', // Usually your repo name.
19+
onBrokenLinks: "error",
20+
onBrokenMarkdownLinks: "error",
21+
onDuplicateRoutes: "error",
22+
favicon: "img/favicon.ico",
23+
organizationName: "Swarm", // Usually your GitHub org/user name.
24+
projectName: "bee-js-docs", // Usually your repo name.
2525
themeConfig: {
2626
colourMode: {
27-
defaultMode: 'dark'
27+
defaultMode: "dark",
2828
},
2929
navbar: {
30-
title: 'Swarm Bee JS Library',
30+
title: "Swarm Bee JS Library",
3131
logo: {
32-
alt: 'Swarm Logo',
33-
src: 'img/swarm-logo-2.svg',
32+
alt: "Swarm Logo",
33+
src: "img/swarm-logo-2.svg",
3434
},
3535
items: [
3636
{
37-
to: 'docs/',
38-
activeBasePath: 'docs',
39-
label: 'Get Started',
40-
position: 'left',
37+
to: "docs/",
38+
activeBasePath: "docs",
39+
label: "Get Started",
40+
position: "left",
4141
},
4242
{
43-
to: 'docs/api',
44-
activeBasePath: 'docs',
45-
label: 'API Reference',
46-
position: 'left',
43+
to: "docs/api",
44+
activeBasePath: "docs",
45+
label: "API Reference",
46+
position: "left",
4747
},
4848
{
49-
href: 'https://github.com/ethersphere/bee-js',
50-
label: 'GitHub',
51-
position: 'right',
49+
href: "https://github.com/ethersphere/bee-js",
50+
label: "GitHub",
51+
position: "right",
5252
},
5353
],
5454
},
5555
footer: {
56-
style: 'dark',
56+
style: "dark",
5757
links: [
5858
{
59-
title: 'Swarm',
59+
title: "Swarm",
6060
items: [
6161
{
62-
label: 'Swarm',
63-
to: 'https://ethswarm.org',
64-
}
62+
label: "Swarm",
63+
to: "https://ethswarm.org",
64+
},
6565
],
6666
},
6767
{
68-
title: 'Community',
68+
title: "Community",
6969
items: [
7070
{
71-
label: 'Discord',
72-
href: 'https://discord.gg/ykCupZMuww',
71+
label: "Discord",
72+
href: "https://discord.gg/ykCupZMuww",
7373
},
7474
{
75-
label: 'Reddit',
76-
href: 'https://www.reddit.com/r/ethswarm',
75+
label: "Reddit",
76+
href: "https://www.reddit.com/r/ethswarm",
7777
},
7878
{
79-
label: 'Twitter',
80-
href: 'https://twitter.com/ethswarm',
79+
label: "Twitter",
80+
href: "https://twitter.com/ethswarm",
8181
},
8282
],
8383
},
8484
{
85-
title: 'More',
85+
title: "More",
8686
items: [
8787
{
88-
label: 'Blog',
89-
href: 'https://medium.com/ethereum-swarm',
88+
label: "Blog",
89+
href: "https://medium.com/ethereum-swarm",
9090
},
9191
{
92-
label: 'GitHub',
93-
href: 'https://github.com/ethersphere/bee-js',
92+
label: "GitHub",
93+
href: "https://github.com/ethersphere/bee-js",
9494
},
9595
],
9696
},
@@ -100,22 +100,17 @@ module.exports = {
100100
},
101101
presets: [
102102
[
103-
'@docusaurus/preset-classic',
103+
"@docusaurus/preset-classic",
104104
{
105105
docs: {
106-
sidebarPath: require.resolve('./sidebars.js'),
107-
// Please change this to your repo.
108-
editUrl:
109-
'https://github.com/ethersphere/bee-js-docs/blob/master',
110-
},
111-
blog: {
112-
showReadingTime: false,
113-
// Please change this to your repo.
114-
editUrl:
115-
'https://github.com/ethersphere/bee-js-docs',
106+
sidebarPath: require.resolve("./sidebars.js"),
107+
editUrl: ({ docPath }) =>
108+
docPath.includes("api/")
109+
? undefined
110+
: "https://github.com/ethersphere/bee-js-docs",
116111
},
117112
theme: {
118-
customCss: require.resolve('./src/css/custom.css'),
113+
customCss: require.resolve("./src/css/custom.css"),
119114
},
120115
},
121116
],

0 commit comments

Comments
 (0)