Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.39 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.39 KB

bunnycdn-storage

GitHub npm

a small wrapper for the bunnycdn storage api

Building

install dependencies with npm/yarn and then run npm build or yarn build

Usage

const BunnyStorage = require('bunnycdn-storage').default;

// No region specified, defaults to Falkenstein (storage.bunnycdn.com)
const bunnyStorage = new BunnyStorage('API-KEY', 'STORAGE-ZONE-NAME');
// Specific region (ny.storage.bunnycdn.com)
const bunnyStorageRegion = new BunnyStorage('API-KEY', 'STORAGE-ZONE-NAME', 'ny');


// list all files in zone / path
const files = await bunnyStorage.list();
const filesInDir = await bunnyStorage.list('/images');

// upload a file from buffer or filename
bunnyStorage.upload('/tmp/bunny.jpg');
bunnyStorage.upload(fs.readFileSync('/tmp/bunny.jpg'), 'bunny.jpg')

// download a file from the servers
bunnyStorage.download('bunny.jpg'); // Buffer (default)
bunnyStorage.download('bunny.jpg', 'arraybuffer'); // Buffer
bunnyStorage.download('bunny.jpg', 'stream'); // ReadableStream

// delete a file
bunnyStorage.delete('bunny.jpg');

Disclaimer

Note that this project and the maintainer(s) of this repository are in no way, shape or form affiliated with BunnyCDN.