Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

cli-width

Package Overview
Dependencies
0
Maintainers
2
Versions
11
Issues
File Explorer

Advanced tools

cli-width

Get stdout window width, with two fallbacks, tty and then a default.

    4.0.0latest

Version published
Maintainers
2
Weekly downloads
19,103,649
decreased by-3.71%

Weekly downloads

Changelog

Source

4.0.0 (2022-03-29)

⚠ BREAKING CHANGES

  • drop support for node < 12

Bug Fixes

  • drop support for node < 12 (50fcd88)

Readme

Source

cli-width

Get stdout window width, with four fallbacks, tty, output.columns, a custom environment variable and then a default.

npm version Build Status Coverage Status

Tested against NodeJS v10+

Usage

npm install --save cli-width 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:

const cliWidth = require('cli-width'); const ttys = require('ttys'); cliWidth({ defaultWidth: 80, output: ttys.output, });

Defines a different tty module to read width from:

const cliWidth = require('cli-width'); const ttys = require('ttys'); cliWidth({ tty: ttys, });

Tests

npm install npm test

Coverage can be generated with npm run coverage.

FAQs

What is cli-width?

Get stdout window width, with two fallbacks, tty and then a default.

Is cli-width popular?

The npm package cli-width receives a total of 18,226,814 weekly downloads. As such, cli-width popularity was classified as popular.

Is cli-width well maintained?

We found that cli-width demonstrated a healthy version release cadence and project activity. It has 2 open source maintainers collaborating on the project.

Last updated on 29 Mar 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc