File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -22,26 +22,26 @@ npm install @softvisio/msgpack
2222``` javascript
2323import * as msgpack from " @softvisio/msgpack" ;
2424
25- const buffer = msgpack .encode ( [ new Date () ] );
25+ const buffer = msgpack .toMsgPack ( [ new Date () ] );
2626
27- const data = msgpack .decode ( buffer );
27+ const data = msgpack .fromMsgPack ( buffer );
2828```
2929
30- ### msgpack.encode ( data, encoding? )
30+ ### msgpack.toMsgPack ( data, encoding? )
3131
3232- ` data ` {any} Data structire to encode.
3333- ` encoding? ` {string} Return string in the specified encoding.
3434- Returns: {Buffer|string} Encoded data. Returns {string} if ` encoding ` parameter is provided.
3535
36- ### msgpack.decode ( data, encoding? )
36+ ### msgpack.fromMsgPack ( data, encoding? )
3737
3838- ` data ` {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
3939- ` encoding? ` {string} String encoding if ` data ` parameter is {string}.
4040- Returns: {any} Decoded data.
4141
4242Throws error if unable to decode message.
4343
44- ### msgpack.decodeStream ( data, offset )
44+ ### msgpack.fromMsgPackStream ( data, offset )
4545
4646- ` data ` {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
4747- ` offset? ` {integer} Offset of the message start in the passed data. ** Default:** ` 0 ` .
Original file line number Diff line number Diff line change @@ -18,26 +18,26 @@ npm install @softvisio/msgpack
1818``` javascript
1919import * as msgpack from " @softvisio/msgpack" ;
2020
21- const buffer = msgpack .encode ( [ new Date () ] );
21+ const buffer = msgpack .toMsgPack ( [ new Date () ] );
2222
23- const data = msgpack .decode ( buffer );
23+ const data = msgpack .fromMsgPack ( buffer );
2424```
2525
26- ### msgpack.encode ( data, encoding? )
26+ ### msgpack.toMsgPack ( data, encoding? )
2727
2828- ` data ` {any} Data structire to encode.
2929- ` encoding? ` {string} Return string in the specified encoding.
3030- Returns: {Buffer|string} Encoded data. Returns {string} if ` encoding ` parameter is provided.
3131
32- ### msgpack.decode ( data, encoding? )
32+ ### msgpack.fromMsgPack ( data, encoding? )
3333
3434- ` data ` {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
3535- ` encoding? ` {string} String encoding if ` data ` parameter is {string}.
3636- Returns: {any} Decoded data.
3737
3838Throws error if unable to decode message.
3939
40- ### msgpack.decodeStream ( data, offset )
40+ ### msgpack.fromMsgPackStream ( data, offset )
4141
4242- ` data ` {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
4343- ` offset? ` {integer} Offset of the message start in the passed data. ** Default:** ` 0 ` .
You can’t perform that action at this time.
0 commit comments