https://github.com/sindresorhus/terminal-size

Reliably get the terminal window size
https://github.com/sindresorhus/terminal-size

Last synced: about 2 months ago
JSON representation

Reliably get the terminal window size

• Host: GitHub
• URL: https://github.com/sindresorhus/terminal-size
• Owner: sindresorhus
• License: mit
• Created: 2016-09-09T16:06:17.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-11-04T17:48:25.000Z (11 months ago)
• Last Synced: 2024-04-14T10:28:45.424Z (5 months ago)
• Language: JavaScript
• Size: 68.4 KB
• Stars: 136
• Watchers: 6
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-nodejs-cn - terminal-size - **star:137** 可靠地获取终端窗口大小 (包 / 命令行实用工具)
• awesome-nodejs - terminal-size - Reliably get the terminal window size. (Packages / Command-line utilities)

README

        
# terminal-size

> Reliably get the terminal window size

Because [`process.stdout.columns`](https://nodejs.org/api/tty.html#tty_writestream_columns) doesn't exist when run [non-interactively](http://www.tldp.org/LDP/abs/html/intandnonint.html), for example, in a child process or when piped. This module even works when all the TTY file descriptors are redirected!

Confirmed working on macOS, Linux, and Windows.

## Install

```sh

npm install terminal-size

```

## Usage

```js

import terminalSize from 'terminal-size';

terminalSize();

//=> {columns: 143, rows: 24}

```

## API

### terminalSize()

Returns an `object` with `columns` and `rows` properties.

## Related

- [terminal-size-cli](https://github.com/sindresorhus/terminal-size-cli) - CLI for this module