msgpack5 - npm Package Compare versions

Comparing version 1.0.3 to 1.1.0

index.js

@@ -5,2 +5,3 @@
   , TOLERANCE = 0.1
+  , streams   = require('./lib/streams')
 
@@ -455,3 +456,5 @@ function msgpack() {
     decode: decode,
-    register: register
+    register: register,
+    encoder: streams.encoder,
+    decoder: streams.decoder
   }
@@ -458,0 +461,0 @@ }

package.json

 {
   "name": "msgpack5",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "A msgpack v5 implementation for node.js, with extension points",
   "main": "index.js",
   "scripts": {
-    "test": "tap test/*",
+    "test": "tape test/* | faucet",
     "jshint": "jshint *.js test/*"
@@ -33,9 +33,13 @@ },
   "devDependencies": {
+    "faucet": "0.0.1",
     "jshint": "^2.5.2",
     "pre-commit": "0.0.9",
-    "tap": "^0.4.11"
+    "tap": "^0.4.11",
+    "tape": "^2.14.0"
   },
   "dependencies": {
-    "bl": "^0.9.0"
+    "bl": "^0.9.0",
+    "inherits": "^2.0.1",
+    "readable-stream": "^1.0.27-1"
   }
 }

README.md

@@ -1,2 +0,2 @@
-msgpack5  [![Build Status](https://travis-ci.org/mcollina/mosca.png)](https://travis-ci.org/mcollina/mosca)
+msgpack5  [![Build Status](https://travis-ci.org/mcollina/msgpack5.png)](https://travis-ci.org/mcollina/msgpack5)
 ========
@@ -64,2 +64,65 @@
 
+API
+---
+
+<a name="api"></a>
+## API
+
+  * <a href="#msgpack"><code><b>msgpack()</b></code></a>
+  * <a href="#encode"><code>msgpack().<b>encode()</b></code></a>
+  * <a href="#decode"><code>msgpack().<b>decode()</b></code></a>
+  * <a href="#register"><code>msgpack().<b>register()</b></code></a>
+  * <a href="#encoder"><code>msgpack().<b>encoder()</b></code></a>
+  * <a href="#decoder"><code>msgpack().<b>decoder()</b></code></a>
+
+-------------------------------------------------------
+<a name="msgpack"></a>
+### msgpack()
+
+Creates a new instance on which you can register new types for being
+encoded.
+
+-------------------------------------------------------
+<a name="encode"></a>
+### encode(object)
+
+Encodes `object` in msgpack, returns a [bl](http://npm.im/bl).
+
+-------------------------------------------------------
+<a name="decode"></a>
+### decode(buf)
+
+Decodes buf from in msgpack. `buf` can be a `Buffer` or a [bl](http://npm.im/bl) instance.
+
+-------------------------------------------------------
+<a name="register"></a>
+### register(type, constructor, encode, decode)
+
+Register a new custom objet type for being automatically encoded and
+decoded. The arguments are:
+
+- `type`, is a positive integer identificating the type once serialized
+- `constructor`, the function that will be used to match the objects
+  with `instanceof`
+- `encode`, a function that will be called to encode an object in binary
+  form
+- `decode`, a function that will be called to decode the object from
+  binary form
+
+-------------------------------------------------------
+<a name="encoder"></a>
+### encoder(opts)
+
+Builds a stream in object mode that encodes msgpack. By default it writes
+an 4 byte length header containing the message length as a UInt32BE. This
+ header can be disabled by passing `{ header: false }` as an option.
+
+-------------------------------------------------------
+<a name="decoder"></a>
+### decoder(opts)
+
+Builds a stream in object mode that decodes msgpack. By default it expects
+msgpack to have a 4 byte length header containing the packaged length as
+a UInt32BE. This header can be disabled by passing `{ header: false }` as an option.
+
 Disclaimer
@@ -66,0 +129,0 @@ ----------

test/1-byte-length-buffers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/1-byte-length-exts.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/1-byte-length-strings.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/15-elements-arrays.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/15-elements-maps.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/16-bits-signed-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/16-bits-unsigned-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/2-bytes-length-arrays.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/2-bytes-length-buffers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/2-bytes-length-exts.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/2-bytes-length-maps.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@ , base = 100000

test/2-bytes-length-strings.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/32-bits-signed-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/32-bits-unsigned-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/32-bytes-strings.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/4-bytes-length-arrays.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/4-bytes-length-buffers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/4-bytes-length-exts.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/4-bytes-length-strings.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/5-bits-negative-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/64-bits-unsigned-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/7-bits-positive-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/8-bits-positive-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/8-bits-signed-integers.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/booleans.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/doubles.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/fixexts.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -46,3 +46,3 @@
       t.deepEqual(encoder.decode(buf), orig, 'must decode correctly')
-      t.type(encoder.decode(buf), MyType, 'must have the correct prototype')
+      t.ok(encoder.decode(buf) instanceof MyType, 'must have the correct prototype')
       t.end()
@@ -101,3 +101,3 @@ })
       t.deepEqual(encoder.decode(buf), orig, 'must decode correctly')
-      t.type(encoder.decode(buf), MyType, 'must have the correct prototype')
+      t.ok(encoder.decode(buf) instanceof MyType, 'must have the correct prototype')
       t.end()
@@ -156,3 +156,3 @@ })
       t.deepEqual(encoder.decode(buf), orig, 'must decode correctly')
-      t.type(encoder.decode(buf), MyType, 'must have the correct prototype')
+      t.ok(encoder.decode(buf) instanceof MyType, 'must have the correct prototype')
       t.end()
@@ -213,3 +213,3 @@ })
       t.deepEqual(encoder.decode(buf), orig, 'must decode correctly')
-      t.type(encoder.decode(buf), MyType, 'must have the correct prototype')
+      t.ok(encoder.decode(buf) instanceof MyType, 'must have the correct prototype')
       t.end()
@@ -273,3 +273,3 @@ })
       buf.writeUInt32BE(orig.data / 4, 14)
-      t.type(encoder.decode(buf), MyType, 'must have the correct prototype')
+      t.ok(encoder.decode(buf) instanceof MyType, 'must have the correct prototype')
       t.deepEqual(encoder.decode(buf), orig, 'must decode correctly')
@@ -371,3 +371,3 @@ t.end()
       t.deepEqual(encoder.decode(buf), orig, 'must decode correctly')
-      t.type(encoder.decode(buf), MyType, 'must have the correct prototype')
+      t.ok(encoder.decode(buf) instanceof MyType, 'must have the correct prototype')
       t.end()
@@ -431,3 +431,3 @@ })
       buf.writeUInt32BE(orig.data / 4, 14)
-      t.type(encoder.decode(buf), MyType, 'must have the correct prototype')
+      t.ok(encoder.decode(buf) instanceof MyType, 'must have the correct prototype')
       t.deepEqual(encoder.decode(buf), orig, 'must decode correctly')
@@ -434,0 +434,0 @@ t.end()

test/floats.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

test/null.js

 
-var test    = require('tap').test
+var test    = require('tape').test
   , msgpack = require('../')
@@ -4,0 +4,0 @@

No alert changes

Improved metrics

Total package byte prevSize

111308

increased by6.08%

Number of package files

41

increased by5.13%

Lines of code

1937

increased by8.27%

Number of lines in readme file

142

increased by79.75%

Worsened metrics

Dependency count

3

increased by200%

Dev dependency count

5

increased by66.67%

Dependency changes

• + Addedinherits@^2.0.1

• + Addedreadable-stream@^1.0.27-1

• + Addedreadable-stream@1.1.14(transitive)