# usage-and-quit

> read a usage file to process.stdout, and quit with some exit code

Latest version **0.0.1** (published 2016-08-19) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install usage-and-quit
pnpm add usage-and-quit
yarn add usage-and-quit
bun add usage-and-quit
```

## 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.1 |
| Published | 2016-08-19 |
| First published | 2016-08-19 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | elsehow |
| Maintainers | elsehow |

## Links

- npm: https://www.npmjs.com/package/usage-and-quit
- npm.io page: https://npm.io/package/usage-and-quit

## Recent versions

- 0.0.1 (latest) — 2016-08-19

## README

# usage-and-quit

read a usage file to process.stdout, and quit with some exit code

## example

```javascript
var join = require('path').join
var pathTo = f => join(__dirname, f)
var usageFile = pathTo('usage.txt')
var usage = require('..')
usage(usageFile)
```

## install

```
npm install usage-and-quit
```

## api
### usage(pathToUsageFile, [exitCode])

will print `pathToUsageFile` to stdout.

`exitCode` is 1 by default.

## license

BSD

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