SDK overview

@bilyai/js gives you one small browser SDK for loading Bily and sending events. It supports ESM, CommonJS, and TypeScript with no runtime dependencies.

Install Bily

npm install @bilyai/js

Use Node.js 16 or newer for build tooling. You can call every public method during server rendering; tracking begins only when the code runs in a browser document.

Choose a method

Export	Return type	Purpose
`init(options)`	`void`	Load Bily from an exact tracking URL
`track(event, payload?)`	`void`	Queue or send an event
`ready()`	`Promise<void>`	Verify that Bily finished loading
`getBilyTrackingId()`	`string \| null`	Read or create the Bily browser identifier

Use exported types

import type {
  BilyAddress,
  BilyClient,
  BilyEvent,
  BilyInitOptions,
  BilyLegacyInitOptions,
  BilyOrder,
  BilyPayload,
  BilyProduct,
  KnownBilyEvent,
} from "@bilyai/js";

See event names and payload types for the complete definitions.

Start now, verify when needed

analytics.ts

import { init, ready, track } from "@bilyai/js";

init({
  scriptUrl: "https://tracking.example.com/b.js?shop=store.example.com",
});

track("workspace_created", { workspace_id: "workspace_456" });

try {
  await ready();
} catch (error) {
  console.error("Bily failed to load", error);
}

You can call track() before ready() resolves. The SDK keeps early calls in a bounded queue, then delivers them in order after Bily loads.

Use one Bily loader. Let init() create it unless your framework guide reserves one script element for the SDK to reuse. Do not add another unmanaged tag.

Reference

Methods

Types

Install Bily

Choose a method

Use exported types

Start now, verify when needed

​Install Bily

​Choose a method

​Use exported types

​Start now, verify when needed

Install Bily

Choose a method

Use exported types

Start now, verify when needed