aws-amplify / docs

AWS Amplify Framework Documentation
https://docs.amplify.aws
Apache License 2.0
482 stars 1.03k forks source link

Download files demo code has syntax error #7490

Open hangoocn opened 4 months ago

hangoocn commented 4 months ago

Describe the content issue: Get or download file from a URL the same code' syntax is not correct:

const linkToStorageFile = await getUrl({
  path: "album/2024/1.jpg",
  // Alternatively, path: ({identityId}) => `album/{identityId}/1.jpg`
  options: {
    validateObjectExistence?: false,  // [error:] extra question mark
    expiresIn?: 20 //  [error:] extra question mark, no comma
    useAccelerateEndpoint: true; //  [error:] comma instead of semi-colon
  },
});

URL page where content issue is: Both Gen 1 and Gen 2 doc have same error: Gen 1: Generate a download URL Gen 2: Get or download file from a URL

Btw, not sure if it is better to set useAccelerateEndpoint to false in the sampl code otherwise user will experience a failure because of missign acceleration setup, or at least we can add a comment there to let user know it may fail.

aspittel commented 4 months ago

Thanks for filing this! Added to the PR here: https://github.com/aws-amplify/docs/pull/7489

hangoocn commented 4 months ago

Thanks @aspittel, I was looking at syntax error in these 3 lines:

options: {
    validateObjectExistence?: false,  // [error:] extra question mark
    expiresIn?: 20 //  [error:] extra question mark, no comma
    useAccelerateEndpoint: true; //  [error:] comma instead of semi-colon
  }

I just added comment for each line error