@libp2p/webrtc 4.0.19 → 4.0.20-f71bc49bd

package/README.md

@@ -1,3 +1,5 @@
+# @libp2p/webrtc
+
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,11 +9,26 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on [WebRTC datachannels](https://webrtc.org/).
 
 ## Example
 
-```js
+```TypeScript
 import { createLibp2p } from 'libp2p'
 import { noise } from '@chainsafe/libp2p-noise'
 import { multiaddr } from '@multiformats/multiaddr'
@@ -21,17 +38,30 @@ import { fromString, toString } from 'uint8arrays'
 import { webRTC } from '@libp2p/webrtc'
 
 const node = await createLibp2p({
-  transports: [webRTC()],
-  connectionEncryption: [noise()],
+  transports: [
+    webRTC()
+  ],
+  connectionEncryption: [
+    noise()
+  ]
 })
 
 await node.start()
 
-const ma =  multiaddr('/ip4/0.0.0.0/udp/56093/webrtc/certhash/uEiByaEfNSLBexWBNFZy_QB1vAKEj7JAXDizRs4_SnTflsQ')
-const stream = await node.dialProtocol(ma, ['/my-protocol/1.0.0'])
-const message = `Hello js-libp2p-webrtc\n`
-const response = await pipe([fromString(message)], stream, async (source) => await first(source))
-const responseDecoded = toString(response.slice(0, response.length))
+const ma = multiaddr('/ip4/0.0.0.0/udp/56093/webrtc/certhash/uEiByaEfNSLBexWBNFZy_QB1vAKEj7JAXDizRs4_SnTflsQ')
+const stream = await node.dialProtocol(ma, '/my-protocol/1.0.0', {
+  signal: AbortSignal.timeout(10_000)
+})
+
+await pipe(
+  [fromString(`Hello js-libp2p-webrtc\n`)],
+  stream,
+  async function (source) {
+    for await (const buf of source) {
+      console.info(toString(buf.subarray()))
+    }
+  }
+)
 ```
 
 # Install