Package Exports
- ordered-binary
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ordered-binary) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
The ordered-binary provides a representation of JavaScript primitives as NodeJS Buffers, such that there binary values are naturally ordered such that it matches primitive ordering. For example, since -2.0321 > -2.04, then toBufferKey(-2.0321) will be greater than toBufferKey(-2.04) as a binary representation, in left-to-right evaluation. This is particular useful for storing keys as binaries with something like LevelDB, to avoid any custom sorting.
The main module exports two functions:
toBufferKey(jsPrimitive) - This accepts a string, number, or boolean as the argument, and returns a Buffer.
fromBufferKey(bufferKey, multiple) - This accepts a Buffer and returns a JavaScript primitive value. This can also parse buffers that hold multiple values delimited by a byte 30, by setting the second argument to true (in which case it will return an array).