string-length

Functions

• stringLength()

Type Aliases

• Options

function stringLength

stringLength: (string: string, options?: Options) => number;

• Get the real length of a string - by correctly counting astral symbols and ignoring [ansi escape codes](https://github.com/sindresorhus/strip-ansi).

  String#length erroneously counts [astral symbols](https://web.archive.org/web/20150721114550/http://www.tlg.uci.edu/~opoudjis/unicode/unicode_astral.html) as two characters.

  Example 1

  import stringLength from 'string-length';
  
  '🐴'.length;
  //=> 2
  
  stringLength('🐴');
  //=> 1
  
  stringLength('\u001B[1municorn\u001B[22m');
  //=> 7

type Options

type Options = {
    /**
	Whether [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) should be counted. They are ignored by default.

	@default false
	*/
    readonly countAnsiEscapeCodes?: boolean;
};