# lynx-scoreboard

> Generic server to act as a Lynx Scoreboard receiver.

Latest version **0.0.4** (published 2020-07-15) · 0 weekly downloads

## Install

```sh
npm install lynx-scoreboard
pnpm add lynx-scoreboard
yarn add lynx-scoreboard
bun add lynx-scoreboard
```

## 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.0.4 |
| Published | 2020-07-15 |
| First published | 2020-07-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 39.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Russel Brewer |
| Maintainers | jasonbyrne |

## Links

- npm: https://www.npmjs.com/package/lynx-scoreboard
- Repository: https://github.com/flocasts/lynx-scoreboard
- Homepage: https://github.com/flocasts/lynx-scoreboard#readme
- Issues: https://github.com/flocasts/lynx-scoreboard/issues
- npm.io page: https://npm.io/package/lynx-scoreboard

## Recent versions

- 0.0.4 (latest) — 2020-07-15
- 0.0.3 — 2020-07-15
- 0.0.2 — 2020-07-15
- 0.0.1 — 2020-07-15

## README

# lynx-scoreboard

Create a Scoreboard Interface to listen to updates from FinishLynx

## Usage Example

```javascript
const scoreboard = await LynxScoreboard.listen({
  port: 8080,
  ip: "127.0.0.1",
});

if (scoreboard.isListening) {
  console.log("I am listening!");
}

scoreboard.subscribe("error", (err) => {
  console.log(`Uh oh! There was an error: ${err}`);
});

scoreboard.subscribe("results", (data) => {
  console.log(`Received ${data.results} from ${data.event.eventName}`);
});

scoreboard.subscribe("directive", (data) => {
  console.log(`Received directive: ${data.title}`);
});

scoreboard.subscribe("stoppedListening", () => {
  console.log(`I stopped listening!`);
});

// Stop listening after 10 seconds
setTimeout(() => scoreboard.stopListening(), 10000);
```

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