@joggr/sdk
v0.1.2
Published
Official TypeScript SDK for the Joggr API
Downloads
299
Readme
@joggr/sdk
Official TypeScript SDK for the Joggr API.
Installation
npm install @joggr/sdk# pnpm
pnpm add @joggr/sdk
# yarn
yarn add @joggr/sdkUsage
import { createClient } from '@joggr/sdk'
const client = createClient({
apiKey: process.env.JOGGR_API_KEY,
})
const { data } = await client.auth.check()
// → { authenticated: true }Configuration
| Option | Type | Required | Default | Description |
| --------- | -------- | -------- | ---------------------- | -------------------------- |
| apiKey | string | Yes | — | API key for authentication |
| baseUrl | string | No | https://api.joggr.ai | Base URL for the Joggr API |
Requirements
- Node.js >= 22.0.0
- ESM only (
require()/ CommonJS is not supported)
License
See LICENSE.md for details.
