Skip to content
This repository was archived by the owner on Jul 21, 2023. It is now read-only.

Commit 5a69d38

Browse files
authored
deps!: update stream types (#232)
libp2p streams are now explicit about the types of sync/sources they provide, showing that they are `AsyncGenerator`s and not just `AsyncIterable`s. Refs: achingbrain/it-stream-types#45 BREAKING CHANGE: the type of the source/sink properties have changed
1 parent 0f39f47 commit 5a69d38

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ dist
66
node_modules
77
package-lock.json
88
yarn.lock
9+
.vscode

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
- [Connection](#connection)
2020
- [API Docs](#api-docs)
2121
- [License](#license)
22-
- [Contribute](#contribute)
22+
- [Contribution](#contribution)
2323

2424
## Install
2525

@@ -60,10 +60,10 @@ await node.start()
6060
await node.dial('/ip4/127.0.0.1/tcp/9090/ws')
6161
```
6262

63-
| Name | Type | Description | Default |
64-
| -------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------- |
65-
| upgrader | [`Upgrader`](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED** |
66-
| filter | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>` | override transport addresses filter | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+[WS, WSS] multiaddrs |
63+
| Name | Type | Description | Default |
64+
| -------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------ |
65+
| upgrader | [`Upgrader`](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED** |
66+
| filter | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>` | override transport addresses filter | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+\[WS, WSS] multiaddrs |
6767

6868
You can create your own address filters for this transports, or rely in the filters [provided](./src/filters.js).
6969

@@ -125,6 +125,6 @@ Licensed under either of
125125
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
126126
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
127127

128-
## Contribute
128+
## Contribution
129129

130130
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -159,32 +159,32 @@
159159
"docs": "aegir docs"
160160
},
161161
"dependencies": {
162-
"@libp2p/interface-connection": "^4.0.0",
163-
"@libp2p/interface-transport": "^2.0.0",
162+
"@libp2p/interface-connection": "^5.0.0",
163+
"@libp2p/interface-transport": "^3.0.0",
164164
"@libp2p/interfaces": "^3.0.3",
165165
"@libp2p/logger": "^2.0.0",
166166
"@libp2p/utils": "^3.0.2",
167167
"@multiformats/mafmt": "^12.0.0",
168168
"@multiformats/multiaddr": "^12.0.0",
169169
"@multiformats/multiaddr-to-uri": "^9.0.2",
170-
"abortable-iterator": "^4.0.2",
171-
"it-ws": "^5.0.6",
170+
"abortable-iterator": "^5.0.0",
171+
"it-ws": "^6.0.0",
172172
"p-defer": "^4.0.0",
173173
"p-timeout": "^6.0.0",
174174
"wherearewe": "^2.0.1",
175175
"ws": "^8.12.1"
176176
},
177177
"devDependencies": {
178-
"@libp2p/interface-mocks": "^9.1.3",
178+
"@libp2p/interface-mocks": "^10.0.0",
179179
"@libp2p/interface-transport-compliance-tests": "^3.0.0",
180180
"@types/ws": "^8.2.2",
181181
"aegir": "^38.1.7",
182182
"is-loopback-addr": "^2.0.1",
183183
"it-all": "^3.0.1",
184-
"it-drain": "^2.0.0",
184+
"it-drain": "^3.0.1",
185185
"it-goodbye": "^4.0.1",
186-
"it-pipe": "^2.0.3",
187-
"it-stream-types": "^1.0.4",
186+
"it-pipe": "^3.0.1",
187+
"it-stream-types": "^2.0.1",
188188
"p-wait-for": "^5.0.0",
189189
"uint8arraylist": "^2.3.2",
190190
"uint8arrays": "^4.0.2"

0 commit comments

Comments
 (0)