You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 21, 2021. It is now read-only.
The [API docs](https://streamr-dev.github.io/streamr-client-javascript/) are automatically generated from the TypeScript source code. They can also be rebuilt locally via:
17
+
18
+
```
19
+
npm run docs
20
+
```
15
21
16
22
### Breaking changes notice
17
23
18
24
* Date TBD: Support for unsigned data will be dropped.
Node v14 or higher is recommended if you intend to use the client in a Node environment. For example, inside a script.
36
44
37
-
## API Docs
38
-
39
-
We have automatically generated API documentation available [here](https://streamr-dev.github.io/streamr-client-javascript/). These docs are generated from the repository TypeScript source code. They can also be rebuilt locally via:
40
-
41
-
```
42
-
npm run docs
43
-
```
44
-
45
45
## Usage
46
46
47
47
Here are some quick examples. More detailed examples for the browser and node.js can be found [here](https://github.com/streamr-dev/streamr-client/tree/master/examples).
@@ -139,10 +139,6 @@ await stream.publish(msg)
139
139
140
140
----
141
141
142
-
# Docs
143
-
144
-
Please see the [API Docs](https://streamr-dev.github.io/streamr-client-javascript/) for auto-generated documentation.
145
-
146
142
## Client options
147
143
148
144
| Option | Default value | Description |
@@ -163,9 +159,7 @@ Please see the [API Docs](https://streamr-dev.github.io/streamr-client-javascrip
163
159
164
160
## Authentication options
165
161
166
-
Note: **Authenticating with an API key has been deprecated.**
167
-
168
-
Note: **Support for email/password authentication will be dropped in the future and cryptographic keys/wallets will be the only supported method.**
162
+
Note: **Authenticating with an API key has been deprecated. Cryptographic keys/wallets is the only supported authentication method.**
169
163
170
164
If you don't have an Ethereum account you can use the utility function `StreamrClient.generateEthereumAccount()`, which returns the address and private key of a fresh Ethereum account.
171
165
@@ -347,7 +341,7 @@ All the below functions return a Promise which gets resolved with the result.
347
341
348
342
## Data Unions
349
343
350
-
This library provides functions for working with Data Unions.
344
+
This library provides functions for working with Data Unions. Please see the [API Docs](https://streamr-dev.github.io/streamr-client-javascript/) for auto-generated documentation on each Data Union endpoint.
| resent |[ResendResponseResent](https://github.com/streamr-dev/streamr-client-protocol-js/blob/master/src/protocol/control_layer/resend_response_resent/ResendResponseResentV1.js)| Fired after `resending` when the subscription has finished resending and message has been processed |
511
505
| error | Error object | Reports errors, for example problems with message content |
512
506
513
-
## Partitioning
507
+
## Stream Partitioning
514
508
515
509
Partitioning (sharding) enables streams to scale horizontally. This section describes how to use partitioned streams via this library. To learn the basics of partitioning, see [the docs](https://streamr.network/docs/streams#partitioning).
0 commit comments