Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correction needed on amplify downloadData #6929

Open
atkreis opened this issue Feb 19, 2024 · 0 comments
Open

Correction needed on amplify downloadData #6929

atkreis opened this issue Feb 19, 2024 · 0 comments
Labels
amplify/js Issues tied to JS

Comments

@atkreis
Copy link

atkreis commented Feb 19, 2024

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/

@reesscot reesscot added the amplify/js Issues tied to JS label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
amplify/js Issues tied to JS
Projects
None yet
Development

No branches or pull requests

2 participants