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

    5.0.1 • 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


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i string-length

    DownloadsWeekly Downloads

    15,259,437

    Version

    5.0.1

    License

    MIT

    Unpacked Size

    4.63 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus