max-mapper / max-mapper/abstract-blob-store

Confirming: No API Guarantee for Filter or Append

Open
#29 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
JavaScript
Stars
275
Forks
25
PR merge metrics
No merged PRs in 30d

Description

Would really appreciate confirmation that createReadStream and createWriteStream make no guarantees relevant for:

  1. Appending data to a blob. To append a blob, users have to stream the existing data to a buffer, then stream it back to the store, with whatever's to be appended tacked on at the end.
  2. Filtering data in a blob. This requires buffering, too.

Many thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the createReadStream and createWriteStream interface entry points and any existing API documentation. Determine whether the interface documents guarantees for appending or filtering blob data; done means the relevant guarantees or limitations are explicitly recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.