api

[juliangruber]

This module currently has 2 apis, which differ in the way encodings are inherited. Those two snippets are equivalent:

value = encodeValue(value, [{ valueEncoding: 'hex' }, db.options]);

var codec = new Codec(db.options);
value = codec.encodeValue(value, { valueEncoding: 'hex' })

The first is more generic as it supports inheritance over n encoding options, whereas the second one works exactly with what we need in levelup.

We could change the class api to take n encoding options too:

var codec = new Codec([optionsA, optionsB]);
value = codec.encodeValue(value, [optionsC, optionsD]);

I guess the real question is: Do we want to make this module truly generic, or tie it to it's main use cases: levelup and multilevel.

Input from people having to use levelup's codec logic would help a lot.

@ralphtheninja @dominictarr @substack

[ralphtheninja]

@juliangruber Do you need it to be more generic for e.g. multilevel? I guess since we are moving this out already and also bumping levelup to 1.0.0 we have more freedom to do what we want.

What would the use case be for:

var codec = new Codec([optionsA, optionsB]);

?

[juliangruber]

I doesn't need to be more generic for multilevel, so I guess it's safe to create an api that works best with levelup and multilevel...

[ralphtheninja]

Yep