athea

Repositories Projects Packages

string-width (5.1.2)

Published 2026-02-24 14:05:37 +00:00 by atheaadmin

Installation

Setup this registry in your project .npmrc file:

registry=

To install the package using npm, run the following command:

npm install string-width@5.1.2

or add it to the package.json file:

"string-width": "5.1.2"

For more information on the npm registry, see the documentation.

About this package

string-width

Get the visual width of a string - the number of columns required to display it

Some Unicode characters are fullwidth and use double the normal width. ANSI escape codes are stripped and doesn't affect the width.

Useful to be able to measure the actual width of command-line output.

Install

$ npm install string-width

Usage

import stringWidth from 'string-width';

stringWidth('a');
//=> 1

stringWidth('古');
//=> 2

stringWidth('\u001B[1m古\u001B[22m');
//=> 2

API

stringWidth(string, options?)

string

Type: string

The string to be counted.

options

Type: object

ambiguousIsNarrow

Type: boolean
Default: false

Count ambiguous width characters as having narrow width (count of 1) instead of wide width (count of 2).

Related

• string-width-cli - CLI for this module
• string-length - Get the real length of a string
• widest-line - Get the visual width of the widest line in a string

---

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.}

Dependencies

Dependencies

ID	Version
eastasianwidth	^0.2.0
emoji-regex	^9.2.2
strip-ansi	^7.0.1

Development Dependencies

ID	Version
ava	^3.15.0
tsd	^0.14.0
xo	^0.38.2

Keywords

string character unicode width visual column columns fullwidth full-width full ansi escape codes cli command-line terminal console cjk chinese japanese korean fixed-width

Details

npm

2026-02-24 14:05:37 +00:00

1

Sindre Sorhus

Project Site

MIT

latest

2.5 KiB

Assets (1)

string-width-5.1.2.tgz 2.5 KiB

Versions (2) View all

5.1.2 2026-02-24

4.2.3 2026-02-24