Installation

Install the Lightning Logs TypeScript SDK in your project.

npm

Install using npm

npm install @lightning-logs/sdk

yarn

Install using yarn

yarn add @lightning-logs/sdk

pnpm

Install using pnpm

pnpm add @lightning-logs/sdk

Monorepo Setup

Using the SDK in a monorepo (workspace)

{
  "dependencies": {
    "@lightning-logs/sdk": "workspace:*"
  }
}

In a monorepo setup, you can reference the SDK as a workspace dependency.

TypeScript Configuration

The SDK is written in TypeScript and includes type definitions

No additional TypeScript configuration is required. The SDK includes full type definitions.

// tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "lib": ["ES2020"],
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

Browser Support

The SDK works in both Node.js and browser environments

The SDK uses the native fetch API, which is available in:

Node.js 18+ (native fetch support)
Modern browsers (Chrome, Firefox, Safari, Edge)
For older Node.js versions, you may need a fetch polyfill