mafintosh / abstract-encoding Goto Github PK

Would be nice to have an official recommendation on optional parameters:

• should they be discouraged
• should they be after offset in encode and end in decode
• any other option?

I'm thinking about following abstract-encoding in https://github.com/ethereumjs/rlp, which has:

rlp.decode(encoded, [skipRemainderCheck=false]) - Decodes a RLP encoded Buffer, Array or String and returns a Buffer or an Array of Buffers. If skipRemainderCheck is enabled rlp will just decode the first rlp sequence in the buffer. By default it would through an error if there is more bytes in Buffer than used by rlp sequence.

Is this argument absolute to the buffer start or relative to the start argument?

EDIT: I guess end implies an absolute value, contrary to length which seems relative to me. Just want to make a note of this here for anyone else

API docs says nothing about what encode/decode should to do when buffer is too small.
Most of modules that uses this interface throwing errors (for example: buffer.readUInt32BE could throw RangeError), but varint has another behavior
Related issue in varint: chrisdickinson/varint#13

cc @chrisdickinson

English isn't my native language, but wouldn't Compliant modules is better than Modules that use this interface?