# rxbf

> Reactive bitFlyer Lightning Library

Latest version **0.2.2** (published 2021-01-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install rxbf
pnpm add rxbf
yarn add rxbf
bun add rxbf
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2021-01-30 |
| First published | 2020-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 53.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Konosuke Kachi |
| Maintainers | gkkachi |
| Keywords | bitflyer, rxjs |

## Links

- npm: https://www.npmjs.com/package/rxbf
- Repository: https://github.com/gkkachi/rxbf
- Homepage: https://github.com/gkkachi/rxbf#readme
- Issues: https://github.com/gkkachi/rxbf/issues
- npm.io page: https://npm.io/package/rxbf

## Dependencies (5)

- [rxjs](https://npm.io/package/rxjs.md) ^6.6.3
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [socket.io-client](https://npm.io/package/socket.io-client.md) 2.4.0
- [node-abort-controller](https://npm.io/package/node-abort-controller.md) ^1.1.0
- [@types/socket.io-client](https://npm.io/package/@types/socket.io-client.md) ^1.4.35

## Recent versions

- 0.2.2 (latest) — 2021-01-30
- 0.2.1 — 2021-01-15
- 0.2.0 — 2021-01-12
- 0.1.9 — 2021-01-07
- 0.1.8 — 2021-01-05
- 0.1.7 — 2021-01-05
- 0.1.6 — 2021-01-05
- 0.1.5 — 2021-01-05
- 0.1.4 — 2021-01-04
- 0.1.3 — 2020-12-31
- 0.1.2 — 2020-12-30
- 0.1.1 — 2020-12-30
- 0.1.0 — 2020-12-30

## README

# rxbf
Reactive bitFlyer Lightning Library

## Install

### `yarn`

```
yarn add rxbf
```

### `npm`

```
npm i -S rxbf
```

## How to use

### HTTP Private API

```typescript
import { HttpAuthClient } from 'rxbf';
const client = new HttpAuthClient(API_KEY, API_SECRET);
client.permissions().then((permissions) => console.log(permissions));
```

### Realtime API

```typescript
import { RealtimeAuthClient } from 'rxbf';
const client = new RealtimeAuthClient(API_KEY, API_SECRET);
client.childOrderEvents().subscribe((event) => console.log('Child order event:', event));
client.ticker('BTC_JPY').subscribe((ticker) => console.log('Ticker:', ticker));
```

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