Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

s3-list-all-objects

0.1.0 • Public • Published

S3 List All Objects

List all keys in a S3 bucket. Takes care of the annoying paging so you don't have to.

Installation

`npm install s3-list-all-objects

Usage

var listAllObjects = require('s3-list-all-objects');

// Get all objects together when they're ready
listAllObjects({ bucket: 'yourbucketname'}, function(err, data) {
    console.log('Got ' + data.length + ' objects, first object: ' + JSON.stringify(data[0]));
});

// Get a callback with each page of objects as they come in
listAllObjects({ bucket: 'yourbucketname, progress: function(err, data) {
    console.log('Got batch ' + data.batchNr + ', isFinal: ' + data.finalBatch + 
                ', object count: ' + data.data.length);
}});

// Get prefixed objects
listAllObjects({ bucket: 'yourbucketname, prefix : 'foldername/'}, function(err, data) {
    console.log('Got ' + data.length + ' objects with prefix.');
});

//Pass options to the S3 constructor to control the operations.
//You can pass credential in here, if you don't the standard AWS environment variables are used.
//See http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property for details

var s3options = {
    accessKeyId : 'NOTAREALACCESSKEYID',
    secretAccessKey : 'NOTAREALSECRETACCESSKEY'
};

 // Get with extra s3 options.
listAllObjects({ bucket: 'yourbucketname', s3options: s3options}, function(err, data) {
    console.log('Got ' + data.length + ' objects, first object: ' + JSON.stringify(data[0]));
});

The options parameter has the following keys:

{
    bucket    : 'bucketname',  //REQUIRED: Name of bucket to list objects from
    
    prefix    : 'foldername/', //OPTIONAL: Only get keys with this prefix
    
    progress  : function(err, data) { }, //OPTIONAL: Called when a page of keys is ready.
                                         // data is { batchNr : <nr>, finalBatch: <true | false>, data : [keys]}
    
    s3options : {...} //OPTIONAL: Options that are passed directly to the S3 constructor in
                      // the AWS SDK. See their documentation for details.

}

You must pass in at least one of callback or options.progress, you can also pass both in.

Keywords

install

npm i s3-list-all-objects

Downloadsweekly downloads

267

version

0.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability