string-length
TypeScript icon, indicating that this package has built-in type declarations

6.0.0 • Public • Published

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.

Related

Package Sidebar

Install

npm i string-length

Weekly Downloads

26,084,824

Version

6.0.0

License

MIT

Unpacked Size

4.25 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus