cli-width

WebJar for cli-width

License

License

ISC
Categories

Categories

CLI User Interface
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

cli-width
Last Version

Last Version

2.2.1
Release Date

Release Date

Type

Type

jar
Description

Description

cli-width
WebJar for cli-width
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/knownasilya/cli-width

Download cli-width

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/cli-width/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>cli-width</artifactId>
    <version>2.2.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/cli-width/
implementation 'org.webjars.npm:cli-width:2.2.1'
// https://jarcasting.com/artifacts/org.webjars.npm/cli-width/
implementation ("org.webjars.npm:cli-width:2.2.1")
'org.webjars.npm:cli-width:jar:2.2.1'
<dependency org="org.webjars.npm" name="cli-width" rev="2.2.1">
  <artifact name="cli-width" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='cli-width', version='2.2.1')
)
libraryDependencies += "org.webjars.npm" % "cli-width" % "2.2.1"
[org.webjars.npm/cli-width "2.2.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

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
"use strict";

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.

Versions

Version
2.2.1
2.2.0
1.1.1