level-codec

level-codec

LevelUP's encoding logic.

API

Codec([opts])

Create a new codec, with a global options object.

This could be something like

var codec = new Codec(db.options);

#encodeKey(key[, opts])

Encode key with given opts.

#encodeValue(value[, opts])

Encode value with given opts.

#encodeBatch(batch[, opts])

Encode batch ops with given opts.

#encodeLtgt(ltgt)

Encode the ltgt values of option object ltgt.

#decodeKey(key[, opts])

Decode key with given opts.

#decodeValue(value[, opts])

Decode value with given opts.

#createStreamDecoder([opts])

Create a function with signature (key, value), that for each key/value pair returned from a levelup read stream returns the decoded value to be emitted.

#keyAsBuffer([opts])

Check whether opts and the global opts call for a binary key encoding.

#valueAsBuffer([opts])

Check whether opts and the global opts call for a binary value encoding.

#encodings

The supported encodings as object of form

{
  "name": {
    "encode": Function,
    "decode": Function,
    "buffer": Boolean,
    "type": String
  }
}

Currently supported encodings:

• utf8
• json
• binary
• hex
• ascii
• base64
• ucs2
• ucs-2
• utf16le
• utf-16le
• none (bypass level-codec)

Publishers

• @juliangruber
• @ralphtheninja

License & copyright

Copyright (c) 2012-2015 LevelUP contributors.

LevelUP is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.