README.md

Archived

We are archiving this repo as the s3 key lister will be taking over from cloudhound https://github.com/bbc/iplayer-catalogue/tree/main/libs/s3-key-lister.

Cloudhound

Flexible and fluent interface finding files in the cloud

Installation

npm install --save cloudhound

Usage

import {S3Hound} from 'cloudhound';

const objects = await S3Hound.newQuery({ bucket: 'myBucket' })
  .prefix('csv')
  .limit(50)
  .find();

console.log(objects);

Documentation

For more examples and API details, see API documentation

Test

npm test

To generate a test coverage report:

npm run coverage

Contributing

See contributing guide

Releasing

1. Bump the version number in package.json npm version patch|minor|major.
2. Commit and push to main.
3. Run npm run no-npm.