www.aleph1.co.uk Git - yaffs-website/blob - node_modules/string-width/readme.md

   1 # string-width [![Build Status](https://travis-ci.org/sindresorhus/string-width.svg?branch=master)](https://travis-ci.org/sindresorhus/string-width)
   2
   3 > Get the visual width of a string - the number of columns required to display it
   4
   5 Some Unicode characters are [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) and use double the normal width. [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code) are stripped and doesn't affect the width.
   6
   7 Useful to be able to measure the actual width of command-line output.
   8
   9
  10 ## Install
  11
  12 ```
  13 $ npm install --save string-width
  14 ```
  15
  16
  17 ## Usage
  18
  19 ```js
  20 const stringWidth = require('string-width');
  21
  22 stringWidth('古');
  23 //=> 2
  24
  25 stringWidth('\u001b[1m古\u001b[22m');
  26 //=> 2
  27
  28 stringWidth('a');
  29 //=> 1
  30 ```
  31
  32
  33 ## Related
  34
  35 - [string-width-cli](https://github.com/sindresorhus/string-width-cli) - CLI for this module
  36 - [string-length](https://github.com/sindresorhus/string-length) - Get the real length of a string
  37 - [widest-line](https://github.com/sindresorhus/widest-line) - Get the visual width of the widest line in a string
  38
  39
  40 ## License
  41
  42 MIT © [Sindre Sorhus](https://sindresorhus.com)