mafintosh / mafintosh/abstract-encoding
Optional parameters in decode/encode
- Dominant language
- No language data
- Stars
- 56
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
Research direction
No files, tests, or entry points are identified in the issue. Review the current encode and decode signatures and documentation, then compare them with the referenced abstract-encoding and ethereumjs/rlp APIs; done means an agreed recommendation for optional-parameter placement and whether such parameters should be supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100