# ftlabs-screens-viewer

> Connects to a screens server with websockets and fires events on url change.

Latest version **3.3.0** (published 2016-06-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install ftlabs-screens-viewer
pnpm add ftlabs-screens-viewer
yarn add ftlabs-screens-viewer
bun add ftlabs-screens-viewer
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.0 |
| Published | 2016-06-30 |
| First published | 2016-03-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | adaroseedwards, jakedchampion, sean.tracey |

## Links

- npm: https://www.npmjs.com/package/ftlabs-screens-viewer
- npm.io page: https://npm.io/package/ftlabs-screens-viewer

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.12.0

## Recent versions

- 3.3.0 (latest) — 2016-06-30
- 3.2.0 — 2016-04-01
- 3.1.0 — 2016-03-30
- 3.0.1 — 2016-03-24
- 2.1.3 — 2016-03-21
- 2.1.2 — 2016-03-21
- 2.1.1 — 2016-03-18
- 2.1.0 — 2016-03-18

## README

# Screens-Viewer
[![Circle CI](https://circleci.com/gh/ftlabs/screens-viewer.svg?style=svg)](https://circleci.com/gh/ftlabs/screens-viewer)

Connects to a screens server with websockets and fires events on url change.


## Example Usage

``` js

const Viewer = require('ftlabs-screens-viewer');

// Create new viewer, give the url of the api which should be connected to.
// storageObject is a persistend storage object has asynchronous getItem and setItem methods.
const viewer = new Viewer('https://example.com', storageObject);
viewer.start();

// The url has changed
viewer.on('change', updateFrameURL);

// A reload has been forced
viewer.on('reload', reloadFrame);

// E.g. The viewer has started but cannot connected to the server.
viewer.on('not-connected', showOfflineMessage);

```

# Developing

Dependencies go into `build/package.json` so they get installed from production.

Commands:

`npm run build` - Builds
`npm run test` - Runs tests

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