open-index/open-npm huggingface dataset:
npm package: @ignite-signals/api
Description: Ignite Signals API package
Latest version: 1.0.80724

<a name="readme-top"></a>

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://signals.ignite.systems">
    <img src="https://signals.ignite.systems/logo.png" alt="Ignite Signals Logo" height="80">
  </a>

<h3 align="center">Ignite Signals API Package</h3>

  <p align="center">
    Best-in-class telemetry collection for Brokers and Insurers
    <br />
    <a href="https://signals.ignite.systems"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://portal.signals.ignite.systems">Open Portal</a>
  </p>
</div>

<!-- GETTING STARTED -->
## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

### Install package

1. Install
```bash
# Using pnpm
pnpm add -D @ignite-signals/api

# Using yarn
yarn add --dev @ignite-signals/api

# Using npm
npm install --save-dev @ignite-signals/api
```
2. Create your client
```ts
import { createClient } from '@ignite-signals/api'

const igniteSignalsClient = createClient('YOUR_API_KEY')
```
3. Start using Ignite Signals! For example here we are checking if a vehicle is compatible with the service
```ts
try {
  const vehicle = igniteSignalsClient.compatibility.checkVehicleCompatibility.query({
    abiCode: '000000',
  })
  if (vehicle.compatible)
    console.log('wahooo 🎉')
}
catch (error) {
  console.log(`error - ${error.code} ${error.message}`)
}
```
4. Refer to the [documentation](https://signals.ignite.systems/packages/api/typescript) for more help