@datagraphics/delivery is a way to push and pull assets to and from S3 the Data Graphics way!
@datagraphics/delivery is available via npm.
npm install -D @datagraphics/deliveryExtends EventEmitter
The base class for @datagraphics/delivery. Create an instance of Delivery to set an interface with S3.
options{bucket: string, basePath: string?, useAccelerateEndpoint: boolean?, shouldBeCached: function (path: string): boolean?}options.bucketThe bucket on S3 to interact withoptions.basePathA pre-defined base path for all interactions with S3. Useful for establishing the slug or prefix of an upload. (optional, default'')options.useAccelerateEndpointIf true, use the Accelerate endpoint (optional, defaultfalse)options.shouldBeCachedA function used to determine whether a file should receive long-lived cache headers. (optional, defaultdefaultShouldBeCached)
const delivery = new Delivery({
bucket: 'apps.thebignews.com',
basePath: 'our-great-project',
});Uploads a single file to S3.
filestring The path to the file to uploadpathstring Where to upload the file relative to the base pathoptions{isPublic: boolean?, shouldCache: boolean?, cacheControlOverride: string?} (optional, default{})options.isPublicWhether a file should be made public or not on upload (optional, defaultfalse)options.shouldCacheWhether a file should have cache headers applied (optional, defaultfalse)options.cacheControlOverrideA custom Cache-Control value that will override the built-in lookup if shouldCache is true
const result = await delivery.uploadFile(
'./data/counties.json', // path to the file on local drive
'counties.json', // the key to give the file in S3, combined with `basePath`
{
isPublic: true,
}
);Returns Promise<UploadOutput>
Upload a directory of files to S3.
dirstring The directory to upload to S3options{prefix: string?, isPublic: boolean?, shouldCache: boolean?, cacheControlOverride: string?} (optional, default{})options.prefixThe prefix to add to the uploaded file's path (optional, default'')options.isPublicWhether all files uploaded should be made public (optional, defaultfalse)options.shouldCacheWhether all files uploaded should get cache headers (optional, defaultfalse)options.cacheControlOverrideA custom Cache-Control value that will override the built-in lookup if shouldCache is true
const result = await delivery.uploadFiles(
'./dist/', // path to the directory on local drive to upload
{
isPublic: true,
prefix: 'output', // the key prefix to combine with `basePath`
}
);Downloads a file from S3 to the local disk.
pathstring The path to the file to downloaddeststring Where to put the file on the local diskoptions{s3ETag: string?} (optional, default{})options.s3ETagIf the ETag from S3 is already known, it can be provided here
const result = await delivery.downloadFile(
'output/data.json', // key of file on S3 to download
'./downloaded/data.json', // where to download the file to the local drive
);Downloads multiple files from a prefix on S3.
prefixstring The prefix to the directory on S3 to download fromdirstring Where to put all the files on the local disk
const result = await delivery.downloadFiles(
'production', // the key of the directory on S3 to download from
'./downloaded/', // where to download the files to the local drive
);These represent the output objects from Delivery's commands.
What downloadFile and downloadFiles returns.
The file's path on S3.
Type: string
Whether the file was identical on S3 or locally and was skipped.
Type: boolean
What uploadFile and uploadFiles returns.
The file's ETag.
Type: string
The file's path on S3.
Type: string
Whether the file was identical on S3 or locally and was skipped.
Type: boolean
This file was made public on upload.
Type: boolean
The size of the uploaded file in bytes.
Type: number
Type: UploadOutput
MIT