Skip to content

Commit

Permalink
Dry up @aws-lite/s3 method comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryanblock
ryanblock committed Sep 28, 2023
1 parent e010b4a commit f768a04
Showing 1 changed file with 34 additions and 33 deletions.
67 changes: 34 additions & 33 deletions plugins/s3/src/put-object.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { readFile, stat } from 'node:fs/promises'
import { Readable } from 'node:stream'

const required = true
const setsReqHeader = 'Set request header: '

const minSize = 1024 * 1024 * 5
const intToHexString = int => String(Number(int).toString(16))
Expand All @@ -26,39 +27,39 @@ const PutObject = {
File: { type: 'string', required, comment: 'File path to be read and uploaded from the local filesystem' },
MinChunkSize: { type: 'number', default: minSize, comment: 'Minimum size (in bytes) to utilize AWS-chunk-encoded uploads to S3' },
// Here come the headers
ACL: { type: 'string', comment: 'Sets header: x-amz-acl' },
BucketKeyEnabled: { type: 'string', comment: 'Sets header: x-amz-server-side-encryption-bucket-key-enabled' },
CacheControl: { type: 'string', comment: 'Sets header: Cache-Control' },
ChecksumAlgorithm: { type: 'string', comment: 'Sets header: x-amz-sdk-checksum-algorithm' },
ChecksumCRC32: { type: 'string', comment: 'Sets header: x-amz-checksum-crc32' },
ChecksumCRC32C: { type: 'string', comment: 'Sets header: x-amz-checksum-crc32c' },
ChecksumSHA1: { type: 'string', comment: 'Sets header: x-amz-checksum-sha1' },
ChecksumSHA256: { type: 'string', comment: 'Sets header: x-amz-checksum-sha256' },
ContentDisposition: { type: 'string', comment: 'Sets header: Content-Disposition' },
ContentEncoding: { type: 'string', comment: 'Sets header: Content-Encoding' },
ContentLanguage: { type: 'string', comment: 'Sets header: Content-Language' },
ContentLength: { type: 'string', comment: 'Sets header: Content-Length' },
ContentMD5: { type: 'string', comment: 'Sets header: Content-MD5' },
ContentType: { type: 'string', comment: 'Sets header: Content-Type' },
ExpectedBucketOwner: { type: 'string', comment: 'Sets header: x-amz-expected-bucket-owner' },
Expires: { type: 'string', comment: 'Sets header: Expires' },
GrantFullControl: { type: 'string', comment: 'Sets header: x-amz-grant-full-control' },
GrantRead: { type: 'string', comment: 'Sets header: x-amz-grant-read' },
GrantReadACP: { type: 'string', comment: 'Sets header: x-amz-grant-read-acp' },
GrantWriteACP: { type: 'string', comment: 'Sets header: x-amz-grant-write-acp' },
ObjectLockLegalHoldStatus: { type: 'string', comment: 'Sets header: x-amz-object-lock-legal-hold' },
ObjectLockMode: { type: 'string', comment: 'Sets header: x-amz-object-lock-mode' },
ObjectLockRetainUntilDate: { type: 'string', comment: 'Sets header: x-amz-object-lock-retain-until-date' },
RequestPayer: { type: 'string', comment: 'Sets header: x-amz-request-payer' },
ServerSideEncryption: { type: 'string', comment: 'Sets header: x-amz-server-side-encryption' },
SSECustomerAlgorithm: { type: 'string', comment: 'Sets header: x-amz-server-side-encryption-customer-algorithm' },
SSECustomerKey: { type: 'string', comment: 'Sets header: x-amz-server-side-encryption-customer-key' },
SSECustomerKeyMD5: { type: 'string', comment: 'Sets header: x-amz-server-side-encryption-customer-key-MD5' },
SSEKMSEncryptionContext: { type: 'string', comment: 'Sets header: x-amz-server-side-encryption-context' },
SSEKMSKeyId: { type: 'string', comment: 'Sets header: x-amz-server-side-encryption-aws-kms-key-id' },
StorageClass: { type: 'string', comment: 'Sets header: x-amz-storage-class' },
Tagging: { type: 'string', comment: 'Sets header: x-amz-tagging' },
WebsiteRedirectLocation: { type: 'string', comment: 'Sets header: x-amz-website-redirect-location' },
ACL: { type: 'string', comment: setsReqHeader + '`x-amz-acl`' },
BucketKeyEnabled: { type: 'string', comment: setsReqHeader + '`x-amz-server-side-encryption-bucket-key-enabled`' },
CacheControl: { type: 'string', comment: setsReqHeader + '`Cache-Control`' },
ChecksumAlgorithm: { type: 'string', comment: setsReqHeader + '`x-amz-sdk-checksum-algorithm`' },
ChecksumCRC32: { type: 'string', comment: setsReqHeader + '`x-amz-checksum-crc32`' },
ChecksumCRC32C: { type: 'string', comment: setsReqHeader + '`x-amz-checksum-crc32c`' },
ChecksumSHA1: { type: 'string', comment: setsReqHeader + '`x-amz-checksum-sha1`' },
ChecksumSHA256: { type: 'string', comment: setsReqHeader + '`x-amz-checksum-sha256`' },
ContentDisposition: { type: 'string', comment: setsReqHeader + '`Content-Disposition`' },
ContentEncoding: { type: 'string', comment: setsReqHeader + '`Content-Encoding`' },
ContentLanguage: { type: 'string', comment: setsReqHeader + '`Content-Language`' },
ContentLength: { type: 'string', comment: setsReqHeader + '`Content-Length`' },
ContentMD5: { type: 'string', comment: setsReqHeader + '`Content-MD5`' },
ContentType: { type: 'string', comment: setsReqHeader + '`Content-Type`' },
ExpectedBucketOwner: { type: 'string', comment: setsReqHeader + '`x-amz-expected-bucket-owner`' },
Expires: { type: 'string', comment: setsReqHeader + '`Expires`' },
GrantFullControl: { type: 'string', comment: setsReqHeader + '`x-amz-grant-full-control`' },
GrantRead: { type: 'string', comment: setsReqHeader + '`x-amz-grant-read`' },
GrantReadACP: { type: 'string', comment: setsReqHeader + '`x-amz-grant-read-acp`' },
GrantWriteACP: { type: 'string', comment: setsReqHeader + '`x-amz-grant-write-acp`' },
ObjectLockLegalHoldStatus: { type: 'string', comment: setsReqHeader + '`x-amz-object-lock-legal-hold`' },
ObjectLockMode: { type: 'string', comment: setsReqHeader + '`x-amz-object-lock-mode`' },
ObjectLockRetainUntilDate: { type: 'string', comment: setsReqHeader + '`x-amz-object-lock-retain-until-date`' },
RequestPayer: { type: 'string', comment: setsReqHeader + '`x-amz-request-payer`' },
ServerSideEncryption: { type: 'string', comment: setsReqHeader + '`x-amz-server-side-encryption`' },
SSECustomerAlgorithm: { type: 'string', comment: setsReqHeader + '`x-amz-server-side-encryption-customer-algorithm`' },
SSECustomerKey: { type: 'string', comment: setsReqHeader + '`x-amz-server-side-encryption-customer-key`' },
SSECustomerKeyMD5: { type: 'string', comment: setsReqHeader + '`x-amz-server-side-encryption-customer-key-MD5`' },
SSEKMSEncryptionContext: { type: 'string', comment: setsReqHeader + '`x-amz-server-side-encryption-context`' },
SSEKMSKeyId: { type: 'string', comment: setsReqHeader + '`x-amz-server-side-encryption-aws-kms-key-id`' },
StorageClass: { type: 'string', comment: setsReqHeader + '`x-amz-storage-class`' },
Tagging: { type: 'string', comment: setsReqHeader + '`x-amz-tagging`' },
WebsiteRedirectLocation: { type: 'string', comment: setsReqHeader + '`x-amz-website-redirect-location`' },
},
request: async (params, utils) => {
let { Bucket, Key, File, MinChunkSize } = params
Expand Down

0 comments on commit f768a04

Please sign in to comment.