<p align="center"></p>
<div align="center">
  <a href="https://www.forcir.com/#gh-light-mode-only" target="_blank">
    <img src="https://cdn.forcir.com/logos/slate.svg" alt="Forcir Logo" height="30">
  </a>
  <a href="https://www.forcir.com/#gh-dark-mode-only" target="_blank">
    <img src="https://cdn.forcir.com/logos/common.svg" alt="Forcir Logo" height="30">
  </a>
</div>
<p align="center"><strong>JavaScript Client Library for the Forcir API</strong></p>

## Install

> Forcir's internal coding standards require version clamping so we've included an `--exact` flag. For your convenience we've placed that flag at the end so you can optionally omit copying it.

```
yarn add forcir --exact
```

### Setup & Configuration

#### Setup

```ts
import { Forcir, ForcirConfig } from 'forcir';

const forcir = new Forcir();
```

#### Configuration Options

#### Usage

```ts
import { Forcir, ForcirConfig } from 'forcir';

const forcir = new Forcir();

forcir.healthCheck().then((response) => console.log(response));
```

<details>
<summary>SEE: Example <strong>ForcirResponse</strong> Shape</summary>

```
ForcirResponse {
  config: { ... },
  data: { ... },
  response: Response { ... },
  status: 200,
  statusText: 'OK',
  url: 'https://api.forcir.com/'
}
```

</details>

### Methods

### Lifecycle Events and Callbacks

### Supported (Built-in) Integrations
