mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 10:54:13 +00:00
1b8300b238
PR-URL: https://github.com/nodejs/node/pull/42122 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Danielle Adams <adamzdanielle@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
30 lines
792 B
TypeScript
30 lines
792 B
TypeScript
declare const stringWidth: {
|
|
/**
|
|
Get the visual width of a string - the number of columns required to display it.
|
|
|
|
Some Unicode characters are [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) and use double the normal width. [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) are stripped and doesn't affect the width.
|
|
|
|
@example
|
|
```
|
|
import stringWidth = require('string-width');
|
|
|
|
stringWidth('a');
|
|
//=> 1
|
|
|
|
stringWidth('古');
|
|
//=> 2
|
|
|
|
stringWidth('\u001B[1m古\u001B[22m');
|
|
//=> 2
|
|
```
|
|
*/
|
|
(string: string): number;
|
|
|
|
// TODO: remove this in the next major version, refactor the whole definition to:
|
|
// declare function stringWidth(string: string): number;
|
|
// export = stringWidth;
|
|
default: typeof stringWidth;
|
|
}
|
|
|
|
export = stringWidth;
|