aboutsummaryrefslogtreecommitdiff
path: root/node_modules/term-size/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/term-size/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/term-size/readme.md')
-rw-r--r--node_modules/term-size/readme.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/term-size/readme.md b/node_modules/term-size/readme.md
new file mode 100644
index 00000000..dd642cad
--- /dev/null
+++ b/node_modules/term-size/readme.md
@@ -0,0 +1,41 @@
+# term-size [![Build Status: Linux & macOS](https://travis-ci.org/sindresorhus/term-size.svg?branch=master)](https://travis-ci.org/sindresorhus/term-size) [![Build Status: Windows](https://ci.appveyor.com/api/projects/status/c3tydg6uedsk0bob/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/term-size/branch/master)
+
+> 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
+
+```
+$ npm install --save term-size
+```
+
+
+## Usage
+
+```js
+const termSize = require('term-size');
+
+termSize();
+//=> {columns: 143, rows: 24}
+```
+
+
+## API
+
+### termSize()
+
+Returns an `Object` with `columns` and `rows` properties.
+
+
+## Related
+
+- [term-size-cli](https://github.com/sindresorhus/term-size-cli) - CLI for this module
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)