Quick Start

Get up and running in less than 5 minutes. This guide covers installation, basic configuration, and your first API call.

Prerequisites

Node.js 18+ and npm/yarn/pnpm. Basic knowledge of TypeScript recommended.

Installation

terminal

npm install @mylib/core @mylib/react
# or
pnpm add @mylib/core @mylib/react

Import and initialize the client in your application entry point. The configuration object accepts the following options:

typescript

import { createClient } from '@mylib/core'

const client = createClient({
  apiKey: process.env.API_KEY,
  region: 'us-east-1',
  timeout: 5000,
})

Never expose your API key in client-side code. Use environment variables.

typescript

const result = await client.query({
  resource: 'users',
  filter: { active: true },
  limit: 10,
})

console.log(result.data) // User[]

You're all set! Explore the API Reference for the full list of available methods.