This library uses promises, so all actions on a B2 instance return a promise in the following pattern:
b2.instanceFunction(arg1, arg2).then(
successFn(response) { ... },
errorFn(err) { ... }
);See the CHANGELOG for a history of updates.
Contributions and questions are welcome. If you are looking for something to help with, please have a look at the ISSUES or add an issue if there is something you would like to see or fix.
Make sure you use the .editorconfig in your IDE/editor when writing code.
Pull Requests should include:
- Updated example in README.md
- Update existing tests, or add new tests to cover code changes
If you are adding tests, add these to /test/unit. Make sure the test is named fooTest.js and
is located in a similar folder to the node module that is being tested.
Always run npm test before you commit.
For this update, we've switched the back end HTTP request library from request to axios as it has better Promise and progress support built in. However, there are a couple changes that will break your code and ruin your day. Here are the changes:
- The Promise resolution has a different data structure. Where previously, the request response data was the root object in the promise resolution (
res), this data now resides inres.data. - In v0.9.12, we added request progress reporting via the third parameter to
then(). Because we are no longer using the same promise library, this functionality has been removed. However, progress reporting is still available by passing a callback function into theb2.method()that you're calling. See the documentation below for details. - In v0.9.x,
b2.downloadFileById()accepted afileIdparameter as a String or Number. As of 1.0.0, the first parameter is now expected to be a plain Object of arguments.
Each request returns an object with:
status- int, html error StatusstatusTextheadersconfigrequestdata- actual returned data from backblaze, https://www.backblaze.com/b2/docs/calling.html
const B2 = require('backblaze-b2');
const b2 = new B2({
accountId: '<accountId>',
applicationKey: 'applicationKey'
});
async function GetBuckets() {
try {
await b2.authorize();
let response = await b2.listBuckets();
console.log(response.data);
} catch (err) {
console.log('Error getting buckets:', err);
}
}To upload large files, you need to split the file into parts (between 5MB and 5GB) and upload each part seperately.
First, you initiate the large file upload to get the fileId:
let response = await this.b2.startLargeFile({bucketId, fileName});
let fileID = response.data.fileId;Then for each part you request an uploadUrl, and use the response to upload the part:
let response = await this.b2.getUploadPartUrl({fileId: this.fileID});
let uploadURL = response.data.uploadUrl;
let authToken = response.data.authorizationToken;
response = await this.b2.uploadPart({
partNumber: parNum,
uploadUrl: uploadURL,
uploadAuthToken: authToken,
data: buf
});
// status checks etc.Then finish the uploadUrl:
let response = await this.b2.finishLargeFile({
fileId: this.fileID,
partSha1Array: parts.map(buf => sha1(buf))
})const B2 = require('backblaze-b2');
// All functions on the b2 instance return the response from the B2 API in the success callback
// i.e. b2.foo(...).then(function(b2JsonResponse) {})
// create b2 object instance
const b2 = new B2({
accountId: 'accountId',
applicationKey: 'applicationKey'
});
// authorize with provided credentials
b2.authorize(); // returns promise
// create bucket
b2.createBucket(
bucketName,
bucketType // one of `allPublic`, `allPrivate`
); // returns promise
// delete bucket
b2.deleteBucket(bucketId); // returns promise
// list buckets
b2.listBuckets(); // returns promise
// update bucket2
b2.updateBucket(bucketId, bucketType); // returns promise
// get upload url
b2.getUploadUrl(bucketId); // returns promise
// upload file
b2.uploadFile({
uploadUrl: 'uploadUrl',
uploadAuthToken: 'uploadAuthToken',
fileName: 'fileName',
mime: '', // optional mime type, will default to 'b2/x-auto' if not provided
data: 'data', // this is expecting a Buffer, not an encoded string
hash: 'sha1-hash', // optional data hash, will use sha1(data) if not provided
info: {
// optional info headers, prepended with X-Bz-Info- when sent, throws error if more than 10 keys set
// valid characters should be a-z, A-Z and '-', all other characters will cause an error to be thrown
key1: 'value'
key2: 'value'
},
onUploadProgress: (event) => {} || null // progress monitoring
}); // returns promise
// list file names
b2.listFileNames({
bucketId: 'bucketId',
startFileName: 'startFileName',
maxFileCount: 100,
delimiter: '',
prefix: ''
}); // returns promise
// list file versions
b2.listFileVersions({
bucketId: 'bucketId',
startFileName: 'startFileName',
maxFileCount: 100
}); // returns promise
// hide file
b2.hideFile({
bucketId: 'bucketId',
fileName: 'fileName'
}); // returns promise
// get file info
b2.getFileInfo(fileId); // returns promise
// get download authorization
b2.getDownloadAuthorization({
bucketId: 'bucketId',
fileNamePrefix: 'fileNamePrefix',
validDurationInSeconds: 'validDurationInSeconds', // a number from 0 to 604800
b2ContentDisposition: 'b2ContentDisposition'
}); // returns promise
// download file by name
b2.downloadFileByName({
bucketName: 'bucketName',
fileName: 'fileName',
responseType: 'arraybuffer', // options are as in axios: 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
onDownloadProgress: (event) => {} || null // progress monitoring
}); // returns promise
// download file by fileId
b2.downloadFileById({
fileId: 'fileId',
responseType: 'arraybuffer', // options are as in axios: 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
onDownloadProgress: (event) => {} || null // progress monitoring
}); // returns promise
// delete file version
b2.deleteFileVersion({
fileId: 'fileId',
fileName: 'fileName'
}); // returns promise
// start large file
b2.startLargeFile({
bucketId: 'bucketId',
fileName: 'fileName'
}); // returns promise
// get upload part url
b2.getUploadPartUrl({
fileId: 'fileId'
}); // returns promise
// get upload part
b2.uploadPart({
partNumber: 'partNumber', // A number from 1 to 10000
uploadUrl: 'uploadUrl',
uploadAuthToken: 'uploadAuthToken', // comes from getUploadPartUrl();
data: Buffer // this is expecting a Buffer not an encoded string,
hash: 'sha1-hash', // optional data hash, will use sha1(data) if not provided
onUploadProgress: (event) => {} || null // progress monitoring
}); // returns promise
// finish large file
b2.finishLargeFile({
fileId: 'fileId',
partSha1Array: [partSha1Array] // array of sha1 for each part
}); // returns promise
// cancel large file
b2.cancelLargeFile({
fileId: 'fileId'
}); // returns promise- Yakov Khalinsky (@yakovkhalinsky)
- Ivan Kalinin (@IvanKalinin) at Isolary
- Brandon Patton (@crazyscience) at Isolary
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent