Skip to content

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

License

Notifications You must be signed in to change notification settings

sindresorhus/string-length

Repository files navigation

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

About

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

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published