aws-amplify / aws-amplify/docs

Correction needed on amplify downloadData

Open
#6,929 0 comments 0 reactions 0 assignees View on GitHub
amplify/js
Dominant language
MDX
Stars
506
Forks
1.1k
Avg merge
3h 14m
Merged PRs (30d)
1

Description

**Describe the content issue**:
On the web page it provides documentation on how to use downloadData. In the example on downloading a file to in-memory buffer, it starts off with this:

// Downloads file content to memory
const { body, eTag } = await downloadData({
key,
data: file,
options: {
...

The "key" part should really be "key: s3Key" or something similar to explicitly say you need the "key:" part. There is another section later where the same thing occurs. Earlier it does show this.

**URL page where content issue is**:
https://docs.amplify.aws/javascript/build-a-backend/storage/download/

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.