forcir

JavaScript Client Library for the Forcir API

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

import { Forcir, ForcirConfig } from 'forcir';

const forcir = new Forcir();

Configuration Options

Usage

import { Forcir, ForcirConfig } from 'forcir';

const forcir = new Forcir();

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

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

Methods

Lifecycle Events and Callbacks

Supported (Built-in) Integrations