Skip to content

docs: describe the file stream contract for storage engines - #1468

Open
UlisesGascon wants to merge 1 commit into
mainfrom
docs/storage-engine-stream
Open

docs: describe the file stream contract for storage engines#1468
UlisesGascon wants to merge 1 commit into
mainfrom
docs/storage-engine-stream

Conversation

@UlisesGascon

Copy link
Copy Markdown
Member

Documents in StorageEngine.md what a custom engine must do with file.stream:

The template is updated accordingly (it used bare pipe() + finish) and was run through a normal and an aborted upload: no leftover file after abort.

Use stream.pipeline, resume() instead of destroy() to skip the rest of a
file, and set file.path before writing so partial files are removed.
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 99.727%. remained the same — docs/storage-engine-stream into main

@UlisesGascon UlisesGascon mentioned this pull request Aug 29, 2026
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants