JavaScript SDK

Installation

The lunary module is lightweight and works with Node JS, Deno, Cloudflare Workers, Vercel Edge functions and even Bun.

Node

npm install lunary

Deno

import lunary from "https://esm.sh/lunary"

Note for Cloudflare Workers

In your wrangler.toml file, make sure to add the Node.js compatibility flag:

compatibility_flags = [ "nodejs_compat" ]

Setup

Start by importing the lunary module:

import lunary from "lunary"

If you're using in the browser, import like this:

import lunary from "lunary/browser"

Then initialize the module with your unique app ID.

Option 1: Automatic using environment variables (recommended):

LUNARY_PUBLIC_KEY="YOUR PROJECT ID"

Option 2: Manually using the .init method:

// Initialize the Lunary module with your unique app ID
lunary.init({
  appId: "YOUR PROJECT ID",
})

The .init method accepts the following arguments:

{
  "appId": string, // Your unique app ID obtained from the dashboard
  "apiUrl": string, // Optional: Use a custom endpoint if you're self-hosting (you can also set LUNARY_API_URL)
  "verbose": boolean // Optional: Enable verbose logging for debugging
}