@datadesk/delivery
@datadesk/delivery
is a way to push and pull assets to and from S3 the Data Desk way!
Installation
@datadesk/delivery
is available via npm
.
npm install -D @datadesk/delivery
Usage
TK TK
API
Table of Contents
Delivery
Extends EventEmitter
The base class for @datadesk/delivery. Create an instance of Delivery to set
an interface with S3.
Parameters
options
{bucket: string, basePath: string}
options.bucket
The bucket on S3 to interact withoptions.basePath
A pre-defined base path for all interactions with S3.
Useful for establishing the slug or prefix of an upload. (optional, default ''
)
Examples
const delivery = new Delivery({
bucket: 'apps.thebignews.com',
basePath: 'our-great-project',
});
uploadFile
Uploads a single file to S3.
Parameters
file
string The path to the file to uploadpath
string Where to upload the file relative to the base pathoptions
{isPublic: boolean?, shouldCache: boolean?} (optional, default {}
)
options.isPublic
Whether a file should be made public or not on upload (optional, default false
)options.shouldCache
Whether a file should have cache headers applied (optional, default false
)
Examples
const result = await delivery.uploadFile(
'./data/counties.json',
'counties.json',
{
isPublic: true,
}
);
Returns Promise<UploadOutput>
uploadFiles
Upload a directory of files to S3.
Parameters
dir
string The directory to upload to S3options
{prefix: string?, isPublic: boolean?, shouldCache: boolean?} (optional, default {}
)
options.prefix
The prefix to add to the uploaded file's path (optional, default ''
)options.isPublic
Whether all files uploaded should be made public (optional, default false
)options.shouldCache
Whether all files uploaded should get cache headers (optional, default false
)
Examples
const result = await delivery.uploadFiles(
'./dist/',
{
isPublic: true,
prefix: 'output',
}
);
downloadFile
Downloads a file from S3 to the local disk.
Parameters
path
string The path to the file to downloaddest
string Where to put the file on the local diskoptions
{s3ETag: string?} (optional, default {}
)
options.s3ETag
If the ETag from S3 is already known, it can be provided here
Examples
const result = await delivery.downloadFile(
'output/data.json',
'./downloaded/data.json',
);
downloadFiles
Downloads multiple files from a prefix on S3.
Parameters
prefix
string The prefix to the directory on S3 to download fromdir
string Where to put all the files on the local disk
Examples
const result = await delivery.downloadFiles(
'production',
'./downloaded/',
);
How outputs are structured
These represent the output objects from Delivery's commands.
DownloadOutput
What downloadFile and downloadFiles returns.
Key
The file's path on S3.
Type: string
isIdentical
Whether the file was identical on S3 or locally and was skipped.
Type: boolean
UploadOutput
What uploadFile and uploadFiles returns.
Key
The file's path on S3.
Type: string
isIdentical
Whether the file was identical on S3 or locally and was skipped.
Type: boolean
isPublic
This file was made public on upload.
Type: boolean
size
The size of the uploaded file in bytes.
Type: number
Delivery#upload
Type: UploadOutput
License
MIT