# twitter-client-ts

> Twitter Stream API client

Latest version **3.0.0** (published 2019-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install twitter-client-ts
pnpm add twitter-client-ts
yarn add twitter-client-ts
bun add twitter-client-ts
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2019-05-08 |
| First published | 2019-05-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.0.0 |
| Dependencies | 1 |
| Unpacked size | 257.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Oswaldo Tedesco |
| Maintainers | oter2901 |

## Links

- npm: https://www.npmjs.com/package/twitter-client-ts
- Repository: https://github.com/oter2901/twitter-client-ts
- Homepage: https://github.com/oter2901/twitter-client-ts#readme
- Issues: https://github.com/oter2901/twitter-client-ts/issues
- npm.io page: https://npm.io/package/twitter-client-ts

## Dependencies (1)

- [mime](https://npm.io/package/mime.md) ^2.4.2

## Recent versions

- 3.0.0 (latest) — 2019-05-08
- 2.0.0 — 2019-05-07

## README

# Twitter Stream API Client

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Travis](https://img.shields.io/travis/oter2901/twitter-client-ts.svg)](https://travis-ci.org/oter2901/twitter-client-ts)

A Twitter Stream API implementation.

### Usage

Comming soon.

### NPM scripts

- `yarn t`: Run test suite
- `yarn start`: Run `npm run build` in watch mode
- `yarn test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
- `yarn test:prod`: Run linting and generate coverage
- `yarn build`: Generate bundles and typings, create docs
- `yarn lint`: Lints code
- `yarn commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)

### Automatic releases

_**Prerequisites**: you need to create/login accounts and add your project to:_

- [npm](https://www.npmjs.com/)
- [Travis CI](https://travis-ci.org)
- [Coveralls](https://coveralls.io)

#### Setup steps

From now on, you'll need to use `yarn commit`, which is a convenient way to create conventional commits.

Automatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library)

### Git Hooks

There is already set a `precommit` hook for formatting your code with Prettier :nail_care:

By default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure:

- You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog)
- Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push`

This makes more sense in combination with [automatic releases](#automatic-releases)

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