Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

string-length

sindresorhus88.8mMIT6.0.0TypeScript support: included

Get the real length of a string - by correctly counting astral symbols and ignoring ansi escape codes

unicode, string, length, size, count, astral, symbol, surrogates, codepoints, ansi, escape, codes

readme

string-length

Get the real length of a string - by correctly counting astral symbols and ignoring ansi escape codes

String#length erroneously counts astral symbols as two characters.

Install

npm install string-length

Usage

import stringLength from 'string-length';

'🐴'.length;
//=> 2

stringLength('🐴');
//=> 1

stringLength('\u001B[1municorn\u001B[22m');
//=> 7

API

stringLength(string, options?)

options

Type: object

countAnsiEscapeCodes

Type: boolean\ Default: false

Whether ANSI escape codes should be counted. They are ignored by default.