Skip to content
Varity Docs

@varity-labs/sdk Installation

Varity Team Core Contributors Updated March 2026

Get the Varity SDK installed and configured in your project.

Install the Package

Section titled “Install the Package”
Terminal window
npm install @varity-labs/sdk

Quick Setup

Section titled “Quick Setup”

  1. Import the SDK

    import { db, resolveCredentials } from '@varity-labs/sdk';

  2. Use the database

    // Create a collection and add data
    const users = db.collection('users');
    await users.add({ name: 'Alice', email: 'alice@example.com' });
    

    // Query data
    const result = await users.get({ limit: 10 });

  3. Check credential status (optional)

    import { resolveCredentials, isUsingDevCredentials } from '@varity-labs/sdk';
    

    const creds = resolveCredentials();
    console.log('Using dev credentials:', isUsingDevCredentials());

Credentials

Section titled “Credentials”

Varity manages all credentials automatically. No environment variables are needed to start developing.

TypeScript Configuration

Section titled “TypeScript Configuration”

The SDK is written in TypeScript. Recommended tsconfig.json settings:

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true
  }
}

Bundle Size

Section titled “Bundle Size”

The SDK supports tree-shaking. Import only what you need.

// Good - imports only what's needed
import { db, resolveCredentials } from '@varity-labs/sdk';


// Avoid - imports the entire package
import * as VaritySDK from '@varity-labs/sdk';

Approximate bundle sizes:

  • Full SDK: ~50KB gzipped
  • Core only: ~20KB gzipped

Next Steps

Section titled “Next Steps”
Section titled “Related Resources”