summaryrefslogtreecommitdiffstats
path: root/node_modules/term-size/readme.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/term-size/readme.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
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 0000000..dd642ca
--- /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)