msgpack5 3.4.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.travis.yml +2 -0
- package/README.md +9 -0
- package/dist/msgpack5.js +2711 -1755
- package/dist/msgpack5.min.js +1 -4
- package/example.js +4 -1
- package/index.js +4 -1
- package/lib/encoder.js +38 -30
- package/lib/streams.js +2 -0
- package/package.json +13 -13
- package/test/1-byte-length-buffers.js +6 -5
- package/test/1-byte-length-exts.js +4 -3
- package/test/1-byte-length-strings.js +4 -3
- package/test/1-byte-length-uint8arrays.js +43 -0
- package/test/15-elements-arrays.js +2 -1
- package/test/15-elements-maps.js +3 -2
- package/test/16-bits-signed-integers.js +3 -2
- package/test/16-bits-unsigned-integers.js +3 -2
- package/test/2-bytes-length-arrays.js +3 -2
- package/test/2-bytes-length-buffers.js +5 -4
- package/test/2-bytes-length-exts.js +4 -3
- package/test/2-bytes-length-maps.js +3 -2
- package/test/2-bytes-length-strings.js +8 -7
- package/test/2-bytes-length-uint8arrays.js +43 -0
- package/test/31-chars-strings.js +7 -4
- package/test/32-bits-signed-integers.js +3 -2
- package/test/32-bits-unsigned-integers.js +3 -2
- package/test/32-bytes-strings.js +2 -1
- package/test/4-bytes-length-arrays.js +3 -2
- package/test/4-bytes-length-buffers.js +5 -4
- package/test/4-bytes-length-exts.js +4 -3
- package/test/4-bytes-length-strings.js +7 -6
- package/test/4-bytes-length-uint8arrays.js +42 -0
- package/test/5-bits-negative-integers.js +2 -1
- package/test/64-bits-signed-integers.js +2 -1
- package/test/64-bits-unsigned-integers.js +2 -1
- package/test/7-bits-positive-integers.js +2 -1
- package/test/8-bits-positive-integers.js +3 -2
- package/test/8-bits-signed-integers.js +3 -2
- package/test/booleans.js +3 -2
- package/test/doubles.js +3 -2
- package/test/ext-custom-encode-check.js +3 -2
- package/test/fixexts.js +21 -20
- package/test/floats.js +3 -2
- package/test/levelup-encoding.js +4 -4
- package/test/null.js +2 -1
- package/test/object-with-buffers.js +4 -3
- package/test/streams.js +3 -2
- package/.npmignore +0 -27
package/.travis.yml
CHANGED
package/README.md
CHANGED
|
@@ -84,6 +84,7 @@ API
|
|
|
84
84
|
---
|
|
85
85
|
|
|
86
86
|
<a name="api"></a>
|
|
87
|
+
|
|
87
88
|
## API
|
|
88
89
|
|
|
89
90
|
* <a href="#msgpack"><code><b>msgpack()</b></code></a>
|
|
@@ -97,6 +98,7 @@ API
|
|
|
97
98
|
|
|
98
99
|
-------------------------------------------------------
|
|
99
100
|
<a name="msgpack"></a>
|
|
101
|
+
|
|
100
102
|
### msgpack(options(obj))
|
|
101
103
|
|
|
102
104
|
Creates a new instance on which you can register new types for being
|
|
@@ -109,12 +111,14 @@ options:
|
|
|
109
111
|
|
|
110
112
|
-------------------------------------------------------
|
|
111
113
|
<a name="encode"></a>
|
|
114
|
+
|
|
112
115
|
### encode(object)
|
|
113
116
|
|
|
114
117
|
Encodes `object` in msgpack, returns a [bl](http://npm.im/bl).
|
|
115
118
|
|
|
116
119
|
-------------------------------------------------------
|
|
117
120
|
<a name="decode"></a>
|
|
121
|
+
|
|
118
122
|
### decode(buf)
|
|
119
123
|
|
|
120
124
|
Decodes buf from in msgpack. `buf` can be a `Buffer` or a [bl](http://npm.im/bl) instance.
|
|
@@ -123,6 +127,7 @@ In order to support a stream interface, a user must pass in a [bl](http://npm.im
|
|
|
123
127
|
|
|
124
128
|
-------------------------------------------------------
|
|
125
129
|
<a name="registerEncoder"></a>
|
|
130
|
+
|
|
126
131
|
### registerEncoder(check(obj), encode(obj))
|
|
127
132
|
|
|
128
133
|
Register a new custom object type for being automatically encoded.
|
|
@@ -136,6 +141,7 @@ The arguments are:
|
|
|
136
141
|
|
|
137
142
|
-------------------------------------------------------
|
|
138
143
|
<a name="registerDecoder"></a>
|
|
144
|
+
|
|
139
145
|
### registerDecoder(type, decode(buf))
|
|
140
146
|
|
|
141
147
|
Register a new custom object type for being automatically decoded.
|
|
@@ -148,6 +154,7 @@ The arguments are:
|
|
|
148
154
|
|
|
149
155
|
-------------------------------------------------------
|
|
150
156
|
<a name="register"></a>
|
|
157
|
+
|
|
151
158
|
### register(type, constructor, encode(obj), decode(buf))
|
|
152
159
|
|
|
153
160
|
Register a new custom object type for being automatically encoded and
|
|
@@ -168,12 +175,14 @@ This is just a commodity that calls
|
|
|
168
175
|
|
|
169
176
|
-------------------------------------------------------
|
|
170
177
|
<a name="encoder"></a>
|
|
178
|
+
|
|
171
179
|
### encoder()
|
|
172
180
|
|
|
173
181
|
Builds a stream in object mode that encodes msgpack.
|
|
174
182
|
|
|
175
183
|
-------------------------------------------------------
|
|
176
184
|
<a name="decoder"></a>
|
|
185
|
+
|
|
177
186
|
### decoder()
|
|
178
187
|
|
|
179
188
|
Builds a stream in object mode that decodes msgpack.
|