mafintosh / mafintosh/abstract-encoding
small buffer
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 56
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
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](https://github.com/chrisdickinson/varint) has [another behavior](https://github.com/chrisdickinson/varint#usage-notes)
Related issue in varint: https://github.com/chrisdickinson/varint/pull/13
cc @chrisdickinson
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the API documentation and the linked varint usage notes and related pull request to compare behavior for undersized buffers. Determine the intended encode/decode contract, document what callers should expect, and ensure the documentation resolves the ambiguity consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100