Getting Started

To begin using the Breeze Uploader SDK, you need to have an API key provided by Breeze. This key is essential for authenticating your requests and interacting with the Breeze file management system. Get your Api Key now for free

Initialization

To use the SDK, you must first import and initialize it with your API and secret key:

import { BreezeUploader } from "breeze-uploader-sdk";

const breeze = new BreezeUploader({
  apiKey: "YOUR_API_KEY",
  secretKey: "YOUR_SECRET_KEY",
});

Example

Uploads a collection of files of any type.

• Arguments

  • files: An array of File objects representing the files to be uploaded.
  • maxSize (optional): The maximum files size allowed.
  • maxFileCount (optional): The maximum number of files allowed to be uploaded in a single operation.

• Returns

  • A Promise<{ files:BreezeFileType[]; error:string|null }> that resolves to an object containing information about the upload process, including completion and error details.

import { BreezeUploader, BreezeFileType } from "breeze-uploader-sdk";

const breeze = new BreezeUploader({
  apiKey: "YOUR_API_KEY",
  secretKey: "YOUR_SECRET_KEY",
});

await breeze.uploadAnyFiles({ files: Array.from(files) });