1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
node-red-nodes/parsers/cbor/README.md

28 lines
864 B
Markdown
Raw Normal View History

2022-07-22 11:18:02 +02:00
node-red-node-cbor
==================
A <a href="http://nodered.org" target="_new">Node-RED</a> node to pack and unpack objects to cbor format buffers.
Install
-------
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-cbor
Changes
-------
Version 1.0.0 - move to cbor-x library (more supported and faster).
Usage
-----
Uses the <a href="https://www.npmjs.org/package/cbor-x">cbor-x npm</a> to pack and unpack msg.payload objects to <a href="https://cbor.io/">cbor</a> format buffers.
**Note**: this node does not currently encode raw <code>buffer</code> types.
It will automatically try to *decode* any buffer received, and may not cause an error.
If the input is NOT a buffer it converts it into a msgpack buffer.
If the input is a msgpack buffer it converts it back to the original type.