@bugstate/js-sdk

JavaScript SDK for BugState Error Monitoring Service.

Install

- From npm:

``bash
npm install @bugstate/js-sdk
`

- Or install locally during development:

`bash


from the package root

npm link

in your project

npm link @bugstate/js-sdk
`

Quick Start

Choose the import style that matches your project.

- ESM (modern):

`js
import BugState from '@bugstate/js-sdk';

const bs = new BugState({ apiKey: process.env.BUGSTATE_API_KEY });
bs.init();

// capture an error
try {
throw new Error('Test error');
} catch (err) {
bs.capture(err);
}
`

- CommonJS (Node.js / older bundlers):

`js
const BugState = require('@bugstate/js-sdk').default || require('@bugstate/js-sdk');

const bs = new BugState({ apiKey: process.env.BUGSTATE_API_KEY });
bs.init();
bs.capture(new Error('Test error'));
`

- TypeScript usage:

`ts
import BugState from '@bugstate/js-sdk';

const bs = new BugState({ apiKey: process.env.BUGSTATE_API_KEY });
bs.init();

// bs has TypeScript types emitted to dist/index.d.ts
`

Configuration Options

Pass an options object to the constructor. Typical options:

- apiKey (string) — Your BugState project API key.
- environment (string) — e.g. production, staging.
- release (string) — application release/version.

Example:

`js
const bs = new BugState({
apiKey: 'your-key',
environment: 'production',
release: '1.2.3'
});
`

API Reference

This README gives integration examples only. For full API details, see the source:

- src/index.ts

Common methods you can expect:

- init() — initialize the SDK and start automatic capture hooks
- capture(error) — send an Error object or message to BugState
- configure(opts) — update SDK configuration at runtime

(Check src/index.ts for exact method names and signatures.)

Build & Publish

This package uses TypeScript. Build before publishing:

`bash
npm run build
`

prepublishOnly` already runs the build, but running it locally is recommended.

Support

Open issues on the repository or contact the package author.