Overview

@darseen/vaze is the official TypeScript/JavaScript client for the Vaze API. It works in Node.js and any runtime with the Fetch API, and ships with full type definitions.

Installation

npm install @darseen/vaze

Create a client

import Vaze from "@darseen/vaze";

const vaze = new Vaze({
  vazeUrl: "https://files.example.com", // your Vaze instance URL
  apiKey: "your-api-key", // created in the dashboard
});

Both options can also be provided through environment variables, in which case new Vaze() needs no arguments:

Response shape

Every SDK method returns the same result envelope instead of throwing on API errors:

type ApiResponse<T> =
  | { data: T; error: null }
  | { data: null; error: { message: string } };

Check error before using data:

const { data, error } = await vaze.files.getAll();

if (error) {
  console.error(error.message);
  return;
}

console.log(data.files); // typed as File[]

Network failures are caught and surfaced the same way, so a single error check covers everything.

Health check

Verify connectivity and that your instance is up:

const { data, error } = await vaze.health();
// data => { message: "Vaze is running!" }

What's next