# flipper-client-sdk

> SDK to build Flipper clients for JS based apps

Latest version **0.0.3** (published 2020-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install flipper-client-sdk
pnpm add flipper-client-sdk
yarn add flipper-client-sdk
bun add flipper-client-sdk
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-09-10 |
| First published | 2020-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 33.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13450 |
| Author | Facebook Inc |
| Maintainers | fb, timurvalievfb |
| Keywords | flipper |

## Links

- npm: https://www.npmjs.com/package/flipper-client-sdk
- Repository: https://github.com/facebook/flipper
- Homepage: https://github.com/facebook/flipper#readme
- Issues: https://github.com/facebook/flipper/issues
- npm.io page: https://npm.io/package/flipper-client-sdk

## Recent versions

- 0.0.3 (latest) — 2020-09-10
- 0.0.2 (beta) — 2020-07-14
- 0.0.1 — 2020-06-11

## README

# flipper-sdk-api

SDK to build Flipper clients for JS based apps

## Installation

`yarn add flipper-client-sdk`

## Usage

## Example

```TypeScript
class SeaMammalPlugin extends AbsctractFlipperPlugin {
  getId(): string {
    return 'sea-mammals';
  }

  runInBackground(): boolean {
    return true;
  }

  newRow(row: {id: string, url: string, title: string}) {
    this.connection?.send("newRow", row)
  }
}

const flipperClient = newWebviewClient();
cosnt plugin = new SeaMammalPlugin();
flipperClient.addPlugin();
flipperClient.start('Example JS App');
plugin.newRow({id: '1', title: 'Dolphin', url: 'example.com'})

```

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