Spaces:
Running
Running
File size: 1,863 Bytes
9ada4bc |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# 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`.
|