\ No newline at end of file
diff --git a/enums/index.FrameType.html b/enums/index.FrameType.html
new file mode 100644
index 0000000..dff2f9b
--- /dev/null
+++ b/enums/index.FrameType.html
@@ -0,0 +1,9 @@
+FrameType | @chainsafe/libp2p-yamux
\ No newline at end of file
diff --git a/index.html b/index.html
index bf4f006..da13cd2 100644
--- a/index.html
+++ b/index.html
@@ -1,40 +1,20 @@
-@chainsafe/libp2p-yamux - v5.0.3
// Connect two yamux muxers to demo basic stream multiplexing functionality
constclientMuxer = yamux({ client:true, onIncomingStream:stream=> { // echo data on incoming streams pipe(stream, stream) }, onStreamEnd:stream=> { // do nothing } })()
constserverMuxer = yamux({ client:false, onIncomingStream:stream=> { // echo data on incoming streams pipe(stream, stream) }, onStreamEnd:stream=> { // do nothing } })()
// `p` is our "connections", what we use to connect the two sides // In a real application, a connection is usually to a remote computer constp = duplexPair()
// connect the muxers together pipe(p[0], clientMuxer, p[0]) pipe(p[1], serverMuxer, p[1])
// now either side can open streams conststream0 = clientMuxer.newStream() conststream1 = serverMuxer.newStream()
// Send some data to the other side constencoder = newTextEncoder() constdata = [encoder.encode('hello'), encoder.encode('world')] pipe(data, stream0)
// Receive data back constresult = awaitpipe(stream0, all)
The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
-
-
Go through the modules and check out existing issues. This is especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
-
Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
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.
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.
\ No newline at end of file
diff --git a/interfaces/index.FrameHeader.html b/interfaces/index.FrameHeader.html
new file mode 100644
index 0000000..a9a1aeb
--- /dev/null
+++ b/interfaces/index.FrameHeader.html
@@ -0,0 +1,20 @@
+FrameHeader | @chainsafe/libp2p-yamux
The flags field is used to provide additional information related to the message type.
+
length
length:number
The meaning of the length field depends on the message type:
+
+
Data - provides the length of bytes following the header
+
Window update - provides a delta update to the window size
+
Ping - Contains an opaque value, echoed back
+
Go Away - Contains an error code
+
+
streamID
streamID:number
The StreamID field is used to identify the logical stream the frame is addressing.
+The client side should use odd ID's, and the server even.
+This prevents any collisions. Additionally, the 0 ID is reserved to represent the session.
\ No newline at end of file
diff --git a/interfaces/index.YamuxMuxerInit.html b/interfaces/index.YamuxMuxerInit.html
new file mode 100644
index 0000000..f3d1f53
--- /dev/null
+++ b/interfaces/index.YamuxMuxerInit.html
@@ -0,0 +1,29 @@
+YamuxMuxerInit | @chainsafe/libp2p-yamux
// Connect two yamux muxers to demo basic stream multiplexing functionality
constclientMuxer = yamux({ client:true, onIncomingStream:stream=> { // echo data on incoming streams pipe(stream, stream) }, onStreamEnd:stream=> { // do nothing } })()
constserverMuxer = yamux({ client:false, onIncomingStream:stream=> { // echo data on incoming streams pipe(stream, stream) }, onStreamEnd:stream=> { // do nothing } })()
// `p` is our "connections", what we use to connect the two sides // In a real application, a connection is usually to a remote computer constp = duplexPair()
// connect the muxers together pipe(p[0], clientMuxer, p[0]) pipe(p[1], serverMuxer, p[1])
// now either side can open streams conststream0 = clientMuxer.newStream() conststream1 = serverMuxer.newStream()
// Send some data to the other side constencoder = newTextEncoder() constdata = [encoder.encode('hello'), encoder.encode('world')] pipe(data, stream0)
// Receive data back constresult = awaitpipe(stream0, all)
+
YamuxStream is used to represent a logical stream within a session
-