docs: add exemple of how encode decode using hex (#111)

mcollina · Dec 8, 2022 · a690317 · a690317
1 parent 5cfdf2d
commit a690317
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -22,8 +22,13 @@ var msgpack = require('msgpack5')() // namespace our extensions
 
 msgpack.register(0x42, MyType, mytipeEncode, mytipeDecode)
 
-console.log(encode({ 'hello': 'world' }).toString('hex'))
+const hex = encode({ 'hello': 'world' }).toString('hex')
+console.log(hex)
 // 81a568656c6c6fa5776f726c64
+const obj = decode(Buffer.from(hex, 'hex'))
+console.log(obj)
+// { hello: 'world' }
+
 console.log(decode(encode({ 'hello': 'world' })))
 // { hello: 'world' }
 console.log(encode(a).toString('hex'))

diff --git a/example.js b/example.js
@@ -8,8 +8,13 @@ const decode = msgpack.decode
 
 msgpack.register(0x42, MyType, mytipeEncode, mytipeDecode)
 
-console.log(encode({ hello: 'world' }).toString('hex'))
+const hex = encode({ hello: 'world' }).toString('hex')
+console.log(hex)
 // 81a568656c6c6fa5776f726c64
+const obj = decode(Buffer.from(hex, 'hex'))
+console.log(obj)
+// { hello: 'world' }
+
 console.log(decode(encode({ hello: 'world' })))
 // { hello: 'world' }
 console.log(encode(a).toString('hex'))