Skip to content

politiken-journalism/tuple-encoding

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tuple-encoding

Encode/decode an Object as a tuple to preserve order using bytewise

Problem

Javascript Objects do not guarantee that the order of keys is preserved. However, this is important if you want to exploit order and use complex objects as keys in eg. leveldb. This module encodes an object as a tuple to solve this problem.

Usage

var tupleEncoding = require('tuple-encoding')

var enc = tupleEncoding(['foo', 'bar'])

enc.encode({foo: 'baz', bar: 'qux'}) // Buffer(' pbaz\u0000pqux\u0000\u0000')

enc.decode(new Buffer(' pbaz\u0000pqux\u0000\u0000', 'binary')) // {foo: 'baz', bar: 'qux'}

API

tupleEncoding : (
  keys: Array<String>
) => {
  encode: Function(obj: Object) => Buffer,
  decode: Function(buf: Buffer) => Object
}

License

ISC

About

Encode/decode an Object as a tuple to preserve order

Resources

License

Stars

Watchers

Forks

Packages

No packages published