bunnycdn-storage-api-node-sdk
v2.0.0
Published
Node SDK to request BunnyCDN API
Downloads
126
Maintainers
Readme
bunnyCDN Storage API Node SDK
Small and simple node SDK to use the BunnyCDN Storage API 🐰
Setup
npm install --save bunnycdn-storage-api-node-sdk
Examples
To initialise
const bunnyCDNStorage = require('bunnycdn-storage-api-node-sdk');
const storage = bunnyCDNStorage(API_STORAGE_KEY, API_STORAGE_ZONE);
Note: All function can be used with a promise or a callback as a response.
Upload a file
const fs = require('fs');
const PATH = '/path/';
const FILE_NAME = 'superPicture.jpeg';
const FILE_BUFFER = fs.readFileSync('./' + FILE_NAME);
// Promise version
storage.putFile(PATH, FILE_NAME, FILE_BUFFER).then(data => {
console.log(data.toString()); // { "HttpCode" : 201, "Message" : "File uploaded." }
}).catch(err => {
console.log(err);
});
// callback version
storage.putFile(PATH, FILE_NAME, FILE_BUFFER, (err, resp, data) => {
console.log(data.toString()); // { "HttpCode" : 201, "Message" : "File uploaded." }
});
Get a file
const FILE_NAME = 'superPicture.jpeg'
// promise version
storage.getFile(PATH, FILE_NAME).then(data => {
// data is a buffer
}).catch(err => {
console.log(err);
});
// callback version
storage.getFile(PATH, FILE_NAME, (err, resp, data) => {
// data is a buffer
});
Delete a file
// promise version
storage.deleteFile(PATH, FILE_NAME).then(data => {
console.log(data); // { HttpCode: 200, Message: 'File deleted successfuly.' }
}).catch(err => {
console.log(err);
});
// callback version
storage.deleteFile(PATH, FILE_NAME, (err, resp, data) => {
console.log(data); // { HttpCode: 200, Message: 'File deleted successfuly.' }
});
Get files
storage.getFiles('/').then(data => {
console.log(data) // data is an array of objects, a list of files
}).catch(err => {
console.log(err);
});
Update the storage zone
storage.setStorageZone('newStorageZone');
Update the API key
storage.setStorageKey('newStorageKey');
Update the API Base URL
storage.setBaseURL('https://');
Build for production
$ npm run build
After running the command, the script is available on the folder "dist". To edit build options, look at the file "build.js" for more details.
Run tests
$ npm run test
Contributing
Contributions, issues and feature requests are welcome!
Show your support
Give a ⭐️ if this project helped you!