Automattic / Automattic/knox

Documentation regarding progress

Open
#298 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
1.7k
Forks
283
PR merge metrics
No merged PRs in 30d

Description

The documentation on upload progress is very sparse : "Note that both putFile and putStream will stream to S3 instead of reading into memory, which is great. And they return objects that emit 'progress' events too, so you can monitor how the streaming goes! The progress events have fields written, total, and percent."

Would it be possible to provide and example using putFile or putStream?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the documentation that describes upload progress for putFile and putStream, then review how those methods emit progress events. Add a runnable example showing progress handling and the written, total, and percent fields; the documentation is done when a reader can monitor an upload from the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.