node-quic - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

lib/index.js

@@ -69,4 +69,5 @@ 'use strict';
             var oldWrite = stream.write.bind(stream);
-            stream.write = function () {
-              oldWrite.apply(undefined, arguments);
+            stream.write = function (data) {
+              if (typeof data !== 'string') data = JSON.stringify(data);
+              oldWrite(data);
               stream.end();
@@ -73,0 +74,0 @@ };

package.json

 {
   "name": "node-quic",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A wrapper around fidm/quic, node-quic is a dead simple stream based QUIC server / client for use in node.js.",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

@@ -1,2 +0,2 @@
-# node-quic
+# node-quic
 
@@ -9,2 +9,68 @@ A wrapper around fidm/quic, node-quic is a dead simple stream based QUIC server / client for use in node.js.
 
-WIP
+node-quic is a simple way to bring QUIC / UDP into your application.
+
+## Installation
+
+```sh
+npm install node-quic
+```
+## Usage
+
+```js
+import quic from 'node-quic'
+
+const port = 1234
+const address = 'localhost' // default
+
+quic.listen(port, address)
+  .then(() => {})               // called once server starts listening
+
+  .onError((error) => {})       // called if there's an error with the listening.
+                                // There are three classes of error:
+                                //    * 'server error'
+                                //    * 'server session error'
+                                //    * 'server stream error'
+                                // An error will come out as an object with key
+                                // `class` containing one of the above. More information
+                                // will be in the error object.
+
+  .onData((data, stream) => {}) // data here will be whatever was sent using quic.send(),
+                                // and stream will have to function properties:
+                                // `write` and `end.` Use stream.write(data) to return
+                                // information to the original sender. Note: stream.write
+                                // will automatically stringify any data sent to it, but
+                                // you will need to parse your own data on the way out of
+                                // `.onData` for `quic.listen` and for `quic.send`.
+                                // Use `stream.end()` if you don't need to send anything back.
+
+quic.send(port, address, data)  // Send data to a listening server. `data` is automatically
+                                // stringified, but will need to be parsed manually on receive.
+
+  .then(() => {})               // called after the stream is written
+
+  .onError((error) => {})       // called on error. The error classes for `quic.send` are:
+                                //   * 'client stream error'
+
+  .onData((data) => {})         // data is populated by whatever the receiving server deems
+                                // necessary to send back.
+```
+
+There are also a few utility functions:
+
+```js
+quic.stopListening()            // kill the server
+
+quic.getServer()                // return low level server object. Note, a server will only be
+                                // returned following a call to `.listen()` and preceding any
+                                // calls to `.stopListening()`, a.k.a. when quic is listening.
+
+quic.getAddress()               // returns an object {
+                                //   port: <number>,
+                                //   family: <string>, // like 'IPv4'
+                                //   address: <string> // defaults to '127.0.0.1'
+                                // }
+                                // Note: these fields will be 0 or the empty string if quic
+                                // is not listening.
+```
+
+Easy Peasy. Enjoy!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23231

increased by62.64%

Lines of code

113

increased by0.89%

Number of lines in readme file

76

increased by660%

No dependency changes