# toggle-api

> A client library for ToggleAPI.

Latest version **0.0.6** (published 2016-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install toggle-api
pnpm add toggle-api
yarn add toggle-api
bun add toggle-api
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2016-08-31 |
| First published | 2016-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Tyler Jones |
| Maintainers | squirly |

## Links

- npm: https://www.npmjs.com/package/toggle-api
- Repository: https://github.com/toggle-api/client-javascript
- Issues: https://github.com/toggle-api/client-javascript/issues
- npm.io page: https://npm.io/package/toggle-api

## Dependencies (2)

- [semver](https://npm.io/package/semver.md) ^5.3.0
- [crypto-js](https://npm.io/package/crypto-js.md) ^3.1.6

## Recent versions

- 0.0.6 (latest) — 2016-08-31
- 0.0.5 — 2016-08-05
- 0.0.4 — 2016-08-04
- 0.0.3 — 2016-08-02
- 0.0.1 — 2016-08-02
- 0.0.0 — 2016-08-02
- 0.1.0 — 2016-08-02

## README

[![CircleCI](https://circleci.com/gh/toggle-api/client-javascript/tree/master.svg?style=svg)](https://circleci.com/gh/toggle-api/client-javascript/tree/master)
[![npm version](https://img.shields.io/npm/v/toggle-api.svg)](https://www.npmjs.com/package/toggle-api)

# Javascript ToggleAPI Client
A javascript client library for ToggleAPI.

## Usage
This package provides a node compatible CommonJS build in the root and a concatenated UMD build in `bundles/`.

This package provides typescript definitions.

All examples are in ES6.

```
import { UserToggles } from 'toggle-api';

// (host, credentials, user_id, [anonymous], [app_version])
toggle = new UserToggles('http://api.toggleapi.com', 'server-api-key', 'userId', '2.0.1', false);

toggle.load().then(() => {
    // (toggle_id, default_value)
    if (toggle.getToggle('my-toggle', false)) {
        console.log('Enabled!');
    } else {
        console.log('Disabled!');
    }
});
```

## Build
This project can be built using: `npm run build`

## Test
This project can be tested using: `npm run test`

---
_Source: https://npm.io/package/toggle-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._