# twitstream

> Twitter streaming module which *I* like

Latest version **0.0.2** (published 2013-11-17) · MIT license · 0 weekly downloads

## Install

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

## 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.2 |
| Published | 2013-11-17 |
| First published | 2013-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Maciej Małecki |
| Maintainers | mmalecki |

## Links

- npm: https://www.npmjs.com/package/twitstream
- Repository: https://github.com/mmalecki/twitstream
- Issues: https://github.com/mmalecki/twitstream/issues
- npm.io page: https://npm.io/package/twitstream

## Dependencies (2)

- [node-uuid](https://npm.io/package/node-uuid.md) 1.4.x
- [oauth-sign](https://npm.io/package/oauth-sign.md) 0.3.x

## Recent versions

- 0.0.2 (latest) — 2013-11-17
- 0.0.1 — 2013-05-24

## README

# twitstream
Twitter streaming module which *I* like.

## Usage

### Creating a client
Create a client tracking `nodejs` search term.
```js
var twitstream = require('twitstream');
var stream = twitstream({
  auth: {
    token: '...',
    tokenSecret: '...',
    consumerKey: '...',
    consumerSecret: '...'
  },
  track: ['hockey']
});
```

### Read tweets
```js
stream.on('readable', function () {
  var tweet = stream.read();
  console.log(JSON.stringify(tweet));
});
```

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