www.aleph1.co.uk Git - yaffs-website/blob - node_modules/window-size/README.md

   1 # window-size [![NPM version](https://badge.fury.io/js/window-size.svg)](http://badge.fury.io/js/window-size)  [![Build Status](https://travis-ci.org/jonschlinkert/window-size.svg)](https://travis-ci.org/jonschlinkert/window-size)
   2
   3 > Reliable way to to get the height and width of the terminal/console in a node.js environment.
   4
   5 ## Install
   6
   7 Install with [npm](https://www.npmjs.com/)
   8
   9 ```sh
  10 $ npm i window-size --save
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var size = require('window-size');
  17 size.height; // "25" (rows)
  18 size.width; // "80" (columns)
  19 ```
  20
  21 ## Other projects
  22
  23 * [base-cli](https://www.npmjs.com/package/base-cli): Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… [more](https://www.npmjs.com/package/base-cli) | [homepage](https://github.com/jonschlinkert/base-cli)
  24 * [lint-deps](https://www.npmjs.com/package/lint-deps): CLI tool that tells you when dependencies are missing from package.json and offers you a… [more](https://www.npmjs.com/package/lint-deps) | [homepage](https://github.com/jonschlinkert/lint-deps)
  25 * [yargs](https://www.npmjs.com/package/yargs): Light-weight option parsing with an argv hash. No optstrings attached. | [homepage](https://github.com/bcoe/yargs#readme)
  26
  27 ## Contributing
  28
  29 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/window-size/issues/new).
  30
  31 ## Author
  32
  33 **Jon Schlinkert**
  34
  35 + [github/jonschlinkert](https://github.com/jonschlinkert)
  36 + [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  37
  38 ## License
  39
  40 Copyright © 2014-2015 [Jon Schlinkert](https://github.com/jonschlinkert)
  41 Released under the MIT license.
  42
  43 ***
  44
  45 _This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on November 15, 2015._