@aws-amplify/storage
Version:
Storage category of aws-amplify
83 lines (81 loc) • 2.95 kB
JavaScript
;
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
Object.defineProperty(exports, "__esModule", { value: true });
exports.downloadData = void 0;
const core_1 = require("@aws-amplify/core");
const utils_1 = require("@aws-amplify/core/internals/utils");
const resolveS3ConfigAndInput_1 = require("../utils/resolveS3ConfigAndInput");
const utils_2 = require("../utils");
const client_1 = require("../utils/client");
const userAgent_1 = require("../utils/userAgent");
const utils_3 = require("../../../utils");
/**
* Download S3 object data to memory
*
* @param input - The DownloadDataInput object.
* @returns A cancelable task exposing result promise from `result` property.
* @throws service: {@link S3Exception} - thrown when checking for existence of the object
* @throws validation: {@link StorageValidationErrorCode } - Validation errors
*
* @example
* ```ts
* // Download a file from s3 bucket
* const { body, eTag } = await downloadData({ key, data: file, options: {
* onProgress, // Optional progress callback.
* } }).result;
* ```
* @example
* ```ts
* // Cancel a task
* const downloadTask = downloadData({ key, data: file });
* //...
* downloadTask.cancel();
* try {
* await downloadTask.result;
* } catch (error) {
* if(isCancelError(error)) {
* // Handle error thrown by task cancelation.
* }
* }
*```
*/
const downloadData = (input) => {
const abortController = new AbortController();
const downloadTask = (0, utils_2.createDownloadTask)({
job: downloadDataJob(input, abortController.signal),
onCancel: (message) => {
abortController.abort(message);
},
});
return downloadTask;
};
exports.downloadData = downloadData;
const downloadDataJob = ({ options: downloadDataOptions, key }, abortSignal) => async () => {
const { bucket, keyPrefix, s3Config } = await (0, resolveS3ConfigAndInput_1.resolveS3ConfigAndInput)(core_1.Amplify, downloadDataOptions);
const finalKey = keyPrefix + key;
utils_3.logger.debug(`download ${key} from ${finalKey}.`);
const { Body: body, LastModified: lastModified, ContentLength: size, ETag: eTag, Metadata: metadata, VersionId: versionId, ContentType: contentType, } = await (0, client_1.getObject)({
...s3Config,
abortSignal,
onDownloadProgress: downloadDataOptions?.onProgress,
userAgentValue: (0, userAgent_1.getStorageUserAgentValue)(utils_1.StorageAction.DownloadData),
}, {
Bucket: bucket,
Key: finalKey,
...(downloadDataOptions?.bytesRange && {
Range: `bytes=${downloadDataOptions.bytesRange.start}-${downloadDataOptions.bytesRange.end}`,
}),
});
return {
key,
body,
lastModified,
size,
contentType,
eTag,
metadata,
versionId,
};
};
//# sourceMappingURL=downloadData.js.map