Lago JavaScript Client

This is a JavaScript wrapper for Lago API. Works in Cloudflare Workers, Deno, and Node.js. Generated from the Lago OpenAPI document.


Current Releases

| Project | Release Badge |
|--------------------|-----------------------------------------------------------------------------------------------------|
| Lago |  |
| Lago JavaScript Client |  |

Installation

For npm users:

``bash
npm install lago-javascript-client
`

`typescript
// npm
import { Client, getLagoError } from 'lago-javascript-client';

// Deno
import { Client, getLagoError } from 'https://deno.land/x/lago/mod.ts';

const lagoClient = Client('__YOUR_API_KEY__');

try {
const { data } = await lagoClient.billableMetrics.createBillableMetric(billableMetric);
} catch (error) {
const lagoError = await getLagoError(error);
}
`

Compatibility

This SDK uses the Fetch API and natively supported Node.js version >= 18. For other Node versions:

1. Ideally, run Node with the --experimental-fetch flag

1. Otherwise, polyfill the Fetch API by doing both:

1. Patching globalThis

1. Pass a Fetch instance to the Lago client

`typescript
import { Client } from 'lago-javascript-client';
import fetch from 'node-fetch';

const lagoClient = Client("api_key", { customFetch: fetch });
`

Usage

Check the Lago API reference

$3

Use the get getLagoError<>() utility function to extract the error object and TypeScript type:

`typescript
try {
const { data } = await lagoClient.billableMetrics.createBillableMetric(billableMetric);
} catch (error) {
const lagoError = await getLagoError(error);
}
`

Development

Uses dnt to build and test for Deno and Node.

$3

Change the affected fields in scripts/build_npm.ts and commit to GitHub. GitHub Actions will build and deploy to npm.

$3

Requires Deno and Node.js >= 18

$3

`bash
deno task generate:openapi
`

$3

`bash
deno task test
`

$3

`bash
deno task build
`

$3

`bash
deno task build
cd npm
npm publish
``

Documentation

The Lago documentation is available at doc.getlago.com.

Contributing

The contribution documentation is available here

License

Lago JavaScript client is distributed under MIT license.