@cgl2/allez NPM

Allez

Allez puts things up in s3, simply.

Usage

const allez = require('@cgl2/allez');

allez.upload(filepath, bucket, {
    folder: 'allez'
}, function(url, error){
    console.log(url);
})

// the upload method is aliased to `oop`. just for fun.
allez.oop(dirpath, bucket, null, function(url, error){
    console.log(url);
})

// options and callback are optional
allez.oop(filepath, bucket)

CLI

For quick uploads, you can add an alias to the upload script in the cli folder:

alias allez='node ~/dev/allez/cli/upload.js'

Usage: allez LOCALPATH FOLDER BUCKET

Folder and bucket are both optional. So, for example: allez file.png

is all you need to upload an image in the current directory to the default bucket.

Members

Functions

Typedefs

oop

a fun alias for upload

Kind: global variable

upload(fileOrDirectoryPath, bucket, options, completion)

Uploads a file, or the contents of a directory to s3

Kind: global function

Param	Type	Description
fileOrDirectoryPath	string	the relative path to the file or directory. If it's a directory, its contents will be uploaded. If it's a file, the file itself will be uploaded.
bucket	string	the bucket to push to
options	Object	options to control upload
options.folder	string	the remote directory to push content to
options.acl	string	the acl to apply. `public-read` by default
options.name	string	the remote name to use for this file. If none is supplied, the file will have the same name as the local file.
options.contentEncoding	string	content encoding to be applied to the file or directory contents. e.g. `gzip`. See AWS docs. If your file ends with `gz` or `gzip`, the encoding will be set for you by default. note that this has undefined results on directory uploads.
options.contentType	string	the content type to be applied. e.g. 'application/json' note that this has undefined results on directory uploads. In the case of `json` or `json.gz` files, this will be set to `application/json` for you automatically.
options.deleteRemoved	boolean	in the case of directory uploads, setting this option to `true` will delete any remote files not present in the local folder. `false` by default.
options.s3Options	Object	s3Options to pass to the s3 client. This contains `accessKeyId` and `secretAccessKey`, to allow you to customize your credentials. By default, allez will use the default s3 credentials on your machine.
completion	uploadCompletion	a completion to fire once done

uploadCompletion : function

A completion to fire on success, or failure, pushing items to s3.

Kind: global typedef

Param	Type
url	string
error	Object

This file is automatically generated. See g_docs.js to make additions.

@auth0/s3

@infinitebrahmanuniverse/nolb-_cg @everything-registry/sub-chunk-163

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago