@bytescale/sdk

Bytescale JavaScript SDK

The Bytescale JavaScript SDK allows you to quickly integrate your application with Bytescale.

Effortlessly upload, optimize, transform, and host your digital media assets.

Installation

npm install @bytescale/sdk

Additional step for Node.js:

npm install node-fetch

Full Documentation

Bytescale JavaScript SDK Full Documentation »

Quick Guide

• Upload a File
• Download a File
• Process a File
• Get File Details
• List Folder
• See All Methods »

Upload a File

import * as Bytescale from "@bytescale/sdk";
import fetch from "node-fetch"; // Node.js only.

const uploadManager = new Bytescale.UploadManager({
  fetchApi: fetch, // 'fetch as any' for TypeScript
  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
});

uploadManager
  .upload({
    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
    // Supported types for 'data' field:
    // - String
    // - Blob
    // - File (i.e. from a DOM file input element)
    // - Buffer
    // - ReadableStream (Node.js), e.g. fs.createReadStream("file.txt")
    data: "Example Data"
  })
  .then(
    uploadedFile => console.log(uploadedFile),
    error => console.error(error)
  );

Download a File

import * as Bytescale from "@bytescale/sdk";
import fetch from "node-fetch"; // Node.js only.

const fileApi = new Bytescale.FileApi({
  fetchApi: fetch, // 'fetch as any' for TypeScript
  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
});

fileApi
  .downloadFile({
    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
    filePath: "/uploads/2022/12/25/hello_world.txt"
  })
  .then(response => response.text()) // .text() | .json() | .blob() | .stream()
  .then(
    fileContents => console.log(fileContents),
    error => console.error(error)
  );

Note: you can also download files using: https://upcdn.io/{accountId}/raw/{filePath}

Process a File

import * as Bytescale from "@bytescale/sdk";
import fetch from "node-fetch"; // Node.js only.

const fileApi = new Bytescale.FileApi({
  fetchApi: fetch, // 'fetch as any' for TypeScript
  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
});

fileApi
  .processFile({
    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
    filePath: "/uploads/2022/12/25/image.jpg",
    transformation: "thumbnail" // Create transformations here: https://www.bytescale.com/dashboard/transformations
  })
  .then(response => response.stream()) // .text() | .json() | .blob() | .stream()
  .then(
    imageByteStream =>
      new Promise((resolve, reject) => {
        const writer = fs.createWriteStream("image-thumbnail.jpg");
        writer.on("close", resolve);
        writer.on("error", reject);
        imageByteStream.pipe(writer);
      })
  )
  .then(
    () => console.log("Thumbnail saved to 'image-thumbnail.jpg'"),
    error => console.error(error)
  );

Note: you can also process files using: https://upcdn.io/{accountId}/{transformation}/{filePath}

Get File Details

import * as Bytescale from "@bytescale/sdk";
import fetch from "node-fetch"; // Node.js only.

const fileApi = new Bytescale.FileApi({
  fetchApi: fetch, // 'fetch as any' for TypeScript
  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
});

fileApi
  .getFileDetails({
    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
    filePath: "/uploads/2022/12/25/image.jpg"
  })
  .then(
    fileDetails => console.log(fileDetails),
    error => console.error(error)
  );

List Folder

import * as Bytescale from "@bytescale/sdk";
import fetch from "node-fetch"; // Node.js only.

const folderApi = new Bytescale.FolderApi({
  fetchApi: fetch, // 'fetch as any' for TypeScript
  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
});

folderApi
  .listFolder({
    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
    folderPath: "/",
    recursive: false
  })
  .then(
    // Note: operation is paginated, see 'result.cursor' and 'params.cursor'.
    result => console.log(`Items in folder: ${result.items.length}`),
    error => console.error(error)
  );

License

MIT