solid-bucket
Advanced tools
Readme
npm install solid-bucket
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('aws', {
accessKeyId: 'accessKeyId',
secretAccessKey: 'secretAccessKey',
region: 'us-east-1' // Optional: "us-east-1" by default
})
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('b2', {
accountId: 'accountId',
applicationKey: 'applicationKey'
})
const SolidBucket = require('solid-bucket')
// How to generate a credentials JSON file: https://cloud.google.com/storage/docs/authentication (To generate a private key in JSON format)
let provider = new SolidBucket('gcs', {
keyFilename: 'keyFilename'
})
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('azure', {
accountName: 'accountName',
accountKey: 'accountKey'
})
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('digitalocean', {
accessKeyId: 'accessKeyId',
secretAccessKey: 'secretAccessKey',
region: 'nyc3' // Optional: "nyc3" by default
})
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('rackspace', {
username: 'username',
apiKey: 'apiKey',
region: 'IAD' // Optional: 'IAD' by default
})
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('wasabi', {
accessKeyId: 'accessKeyId',
secretAccessKey: 'secretAccessKey',
})
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('s3compatible', {
endpoint: 'endpoint',
accessKeyId: 'accessKeyId',
secretAccessKey: 'secretAccessKey',
})
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('folder', {
folderPath: 'folderPath'
})
provider.createBucket(bucketName) // returns a Promise
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('azure', {
accountName: 'accountName',
accountKey: 'accountKey'
})
let bucketName = 'example'
provider.createBucket(bucketName).then((resp) => {
if (resp.status === 201) {
console.log(resp.message)
// Output: Bucket "example" was created successfully
}
}).catch((resp) => {
if (resp.status === 400){
console.log(resp.message)
// Output: Some error coming from the provider...
}
})
provider.deleteBucket(bucketName) // returns a Promise
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('azure', {
accountName: 'accountName',
accountKey: 'accountKey'
})
let bucketName = 'example'
provider.deleteBucket(bucketName).then((resp) => {
if (resp.status === 200) {
console.log(resp.message)
// Output: Bucket "example" was deleted successfully
}
}).catch((resp) => {
if (resp.status === 400){
console.log(resp.message)
// Output: Some error coming from the provider...
}
})
provider.saveObjectIntoBucket(bucketName, filename, object) // returns a Promise
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('azure', {
accountName: 'accountName',
accountKey: 'accountKey'
})
let bucketName = 'example'
let filename = 'my_remote_object.txt'
let object = {
name: 'This is my name',
surname: 'This is my surname',
age: 30
}
provider.saveObjectIntoBucket(bucketName, filename, object).then((resp) => {
if (resp.status === 200) {
console.log(resp.message)
// Output: Object "example.txt" was saved successfully in bucket "example"
}
}).catch((resp) => {
if (resp.status === 400){
console.log(resp.message)
// Output: Some error coming from the provider...
}
})
provider.deleteObjectFromBucket(bucketName, filename) // returns a Promise
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('azure', {
accountName: 'accountName',
accountKey: 'accountKey'
})
let bucketName = 'example'
let filename = 'my_remote_object.txt'
provider.deleteObjectFromBucket(bucketName, filename).then((resp) => {
if (resp.status === 200) {
console.log(resp.message)
// Output: Object "example.txt" was deleted successfully from bucket "example"
}
}).catch((resp) => {
if (resp.status === 400){
console.log(resp.message)
// Output: Some error coming from the provider...
}
})
provider.getObjectFromBucket(bucketName, filename) // returns a Promise
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('azure', {
accountName: 'accountName',
accountKey: 'accountKey'
})
let bucketName = 'example'
let filename = 'my_remote_object.txt'
provider.getObjectFromBucket(bucketName, filename).then((resp) => {
if (resp.status === 200) {
console.log(resp.message)
// Output: Object "example.txt" was fetched successfully from bucket "example"
}
}).catch((resp) => {
if (resp.status === 400){
console.log(resp.message)
// Output: Some error coming from the provider...
}
})
provider.getListOfObjectsFromBucket(bucketName) // returns a Promise
const SolidBucket = require('solid-bucket')
let provider = new SolidBucket('azure', {
accountName: 'accountName',
accountKey: 'accountKey'
})
let bucketName = 'example'
provider.getListOfObjectsFromBucket(bucketName).then((resp) => {
if (resp.status === 200) {
console.log(resp.message)
// Output: The list of objects was fetched successfully from bucket "example"
}
}).catch((resp) => {
if (resp.status === 400){
console.log(resp.message)
// Output: Some error coming from the provider...
}
})
Required Environmental vars depending on the provider:
Afterwards, just run:
npm test
MIT
FAQs
A universal API for Cloud Storage providers. Supports: Amazon AWS S3, Backblaze B2, Microsoft Azure Blob, DigitalOcean Spaces, Rackspace Cloud Storage, Wasabi Object Storage and any S3-Compatible cloud storage or Folder (e.g NAS)
We found that solid-bucket demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.