# user-stream

> Simple twitter user stream client. Only one dependency (oauth).

Latest version **0.0.8** (published 2016-12-17) · 0 weekly downloads

## Install

```sh
npm install user-stream
pnpm add user-stream
yarn add user-stream
bun add user-stream
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2016-12-17 |
| First published | 2012-10-26 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 157 |
| Author | Aivis Silins |
| Maintainers | aivis |
| Keywords | twitter, streaming |

## Links

- npm: https://www.npmjs.com/package/user-stream
- Repository: https://github.com/aivis/user-stream
- Homepage: https://github.com/aivis/user-stream#readme
- Issues: https://github.com/aivis/user-stream/issues
- npm.io page: https://npm.io/package/user-stream

## Dependencies (1)

- [oauth](https://npm.io/package/oauth.md) 0.9.8

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2016-12-17
- 0.0.7 — 2013-10-10
- 0.0.6 — 2013-10-10
- 0.0.5 — 2012-11-22
- 0.0.4 — 2012-10-29
- 0.0.3 — 2012-10-29
- 0.0.2 — 2012-10-26
- 0.0.1 — 2012-10-26

## README

user-stream
=============
[![NPM module](https://badge.fury.io/js/user-stream.png)](https://badge.fury.io/js/user-stream)

Simple Node.js Twitter (API 1.1) user stream client (https://dev.twitter.com/docs/streaming-apis/streams/user)

[![NPM](https://nodei.co/npm/user-stream.png?stars&downloads)](https://nodei.co/npm/user-stream/)

Install
-------
```npm install user-stream```

Usage
-------
```javascript
var Stream = require('user-stream');
var stream = new Stream({
    consumer_key: '',
    consumer_secret: '',
    access_token_key: '',
    access_token_secret: ''
});

//create stream
stream.stream();

//listen stream data
stream.on('data', function(json) {
  console.log(json);
});
```

Events
-------
- ```data```        - stream data in JSON format
- ```garbage```     - stream data who can't be parsed to JSON
- ```close```       - stream close event (stream connection closed)
- ```error```       - error event (request error, response error, response status code greater than 200)
- ```connected```   - stream created
- ```heartbeat```   - twitter emitted heartbeat

Methods
-------
- ```stream```  - create stream connection
- ```destroy``` - destroy/close stream connection

### Streaming API request parameters [link](https://dev.twitter.com/docs/streaming-apis/parameters) ###
```javascript
var params = {
    with: 'user'
}
//create stream
stream.stream(params);
```
#### Reserved parameters for lib
- ```delimited``` 
- ```stall_warnings```

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