Sha256: 13b3d927e157b1f5428c2d025c804b202284ceae9268a149c3ded7efb52b633a
Contents?: true
Size: 1.82 KB
Versions: 29
Compression:
Stored size: 1.82 KB
Contents
# cli-width
Get stdout window width, with four fallbacks, `tty`, `output.columns`, a custom environment variable and then a default.
[](http://badge.fury.io/js/cli-width)
[](https://travis-ci.org/knownasilya/cli-width)
[](https://coveralls.io/github/knownasilya/cli-width?branch=master)
Tested against Node v12 to v20.
Includes TypeScript types.
## Usage
```
npm install --save cli-width
```
```js
const cliWidth = require('cli-width');
cliWidth(); // maybe 204 :)
```
You can also set the `CLI_WIDTH` environment variable.
If none of the methods are supported, and the environment variable isn't set,
the default width value is going to be `0`, that can be changed using the configurable `options`.
## API
### cliWidth([options])
`cliWidth` can be configured using an `options` parameter, the possible properties are:
- **defaultWidth**\<number\> Defines a default value to be used if none of the methods are available, defaults to `0`
- **output**\<object\> A stream to be used to read width values from, defaults to `process.stdout`
- **tty**\<object\> TTY module to try to read width from as a fallback, defaults to `require('tty')`
### Examples
Defining both a default width value and a stream output to try to read from:
```js
const cliWidth = require('cli-width');
const ttys = require('ttys');
cliWidth({
defaultWidth: 80,
output: ttys.output,
});
```
Defines a different tty module to read width from:
```js
const cliWidth = require('cli-width');
const ttys = require('ttys');
cliWidth({
tty: ttys,
});
```
## Tests
```bash
npm install
npm test
```
Coverage can be generated with `npm run coverage`.
Version data entries
29 entries across 29 versions & 2 rubygems