# observ-listen

> Trigger observ/watch or normal listening via a single interface

Latest version **1.0.0** (published 2015-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install observ-listen
pnpm add observ-listen
yarn add observ-listen
bun add observ-listen
```

## 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 | 1.0.0 |
| Published | 2015-10-23 |
| First published | 2015-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | observable, observ, listen, fn |

## Links

- npm: https://www.npmjs.com/package/observ-listen
- Repository: https://github.com/bendrucker/observ-listen
- Homepage: https://github.com/bendrucker/observ-listen#readme
- Issues: https://github.com/bendrucker/observ-listen/issues
- npm.io page: https://npm.io/package/observ-listen

## Dependencies (2)

- [ap](https://npm.io/package/ap.md) ~0.2.0
- [observ](https://npm.io/package/observ.md) ~0.2.0

## Recent versions

- 1.0.0 (latest) — 2015-10-23

## README

# observ-listen [![Build Status](https://travis-ci.org/bendrucker/observ-listen.svg?branch=master)](https://travis-ci.org/bendrucker/observ-listen)

> Trigger observ/watch or normal listening via a single interface


## Install

```
$ npm install --save observ-listen
```


## Usage

```js
var Observ = require('observ')
var listen = require('observ-listen')
var observable = Observ()

// Listen
listen(observable, function (value) {
  //=> 1
})
observable.set(1)

// Watch
listen(observable, function (value) {
  //=> 1
}, true)
```

## API

#### `listen(observable, fn, [watch])` -> `function`

Returns an unlisten function.

##### observable

*Required*  
Type: `function`

An observable like from [observ](https://github.com/raynos/observ).

##### fn

*Required*  
Type: `function`

A listener to call when the observable changes and initially if `watch` is set.

##### watch

Type: `boolean`  
Default: `false`

If true, the listener will be called immediately with the current value.

## License

MIT © [Ben Drucker](http://bendrucker.me)

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