backblaze-b2 Node.js Library

The library allows you to pass axios configuration at two levels:

1. Global Level: Pass an axios object during new B2({...}) instantiation to set default configurations for all requests.
2. Request Level: Pass axios or axiosOverride arguments to specific method calls.

Behavioral difference:

• axios: Properties are added to the request object only if they do not conflict with existing properties. It performs a recursive merge.
• axiosOverride: Properties are added by overriding conflicting properties. Use this with caution.

Example of request-level configuration:

const common_args = {
    axios: {
        timeout: 30000
    }
};

b2.getBucket({ bucketName: 'my-bucket' }, common_args);

Every request made through the B2 instance returns a response object containing the following fields:

• status: int, the HTTP error status code.
• statusText: the HTTP status text.
• headers: the response headers.
• config: the axios request configuration.
• request: the axios request object.
• data: the actual data returned from the Backblaze B2 API.

The library switched its HTTP backend from request to axios. If you are upgrading from version 0.9.x, note the following breaking changes:

1. Response Data Structure: The response data is no longer the root object in the promise resolution. You must now access it via res.data.
2. Progress Reporting: The third parameter to .then() used for progress reporting in v0.9.12 has been removed. To report progress, you must now pass a callback function as an argument to the B2 method itself (e.g., b2.method(args, callback)).
3. downloadFileById Signature: The method no longer accepts a fileId as the first parameter. It now expects a plain Object of arguments as the first parameter.

To use the library, instantiate a new B2 object with your credentials. You can use either applicationKeyId and applicationKey or accountId and masterApplicationKey.

By default, the client automatically retries requests. You can configure the global axios instance and the retry behavior during instantiation.

const B2 = require('backblaze-b2');

const b2 = new B2({
  applicationKeyId: 'applicationKeyId', // or accountId: 'accountId'
  applicationKey: 'applicationKey' // or masterApplicationKey
});

Before performing any actions, you must call authorize(). Authorization typically lasts for 24 hours. All subsequent method calls on the b2 instance return promises.

await b2.authorize();

You can download files either by their name or their unique fileId.

• downloadFileByName({ bucketName, fileName, responseType, onDownloadProgress })
• downloadFileById({ fileId, responseType, onDownloadProgress })

Options:

• responseType: Determines how the data is returned. Supported values (via axios): 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'.
• onDownloadProgress: Callback for monitoring download progress.

Use the following methods to manage your B2 buckets:

• createBucket({ bucketName, bucketType }): Creates a new bucket. bucketType can be allPublic or allPrivate.
• deleteBucket({ bucketId }): Deletes a bucket.
• listBuckets(): Lists all buckets.
• getBucket({ bucketName, bucketId }): Retrieves bucket information.
• updateBucket({ bucketId, bucketType }): Updates bucket properties.

Use these methods to manage application keys and their capabilities:

• createKey({ capabilities, keyName, validDurationInSeconds, bucketId, namePrefix }): Creates a new key. capabilities is an array of strings (e.g., ['readFiles'] or b2.KEY_CAPABILITIES.READ_FILES).
• deleteKey({ applicationKeyId }): Deletes a specific key.
• listKeys({ maxKeyCount, startApplicationKeyId }): Lists available keys.

The backblaze-b2 library organizes its API actions into four main modules. You can access these modules via the main entry point to perform operations related to authentication, bucket management, file manipulation, and key management.

• auth: Handles authentication and session management.
• bucket: Provides methods for managing B2 buckets.
• file: Provides methods for uploading, downloading, and managing files.
• key: Provides methods for managing API keys.

const b2 = require('backblaze-b2');

// Accessing the action modules
const auth = b2.auth;
const bucket = b2.bucket;
const file = b2.file;
const key = b2.key;

The library exports the main B2 client functionality. To use it, require the module and instantiate the client. The client provides methods for interacting with the Backblaze B2 API, such as authentication, bucket management, and file operations.

const B2 = require('backblaze-b2');
const b2 = new B2({
  applicationKeyId: 'YOUR_KEY_ID',
  applicationKey: 'YOUR_APPLICATION_KEY'
});