Package Exports
- @slimio/wcwidth
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@slimio/wcwidth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
wcwidth
Determine columns needed for a fixed-size wide-character string
wcwidth is a simple JavaScript port of wcwidth implemented in C by Markus Kuhn.
JavaScript port originally written by Woong Jun woong.jun@gmail.com (http://code.woong.org/)
Why
This package is a fork of wcwidth.
- Drop old Node.js version support.
- Drop useless
defaults
package wich introduce an indirect dependencies. - Cleanup npm tarball (only ship required files).
- Supported by the SlimIO Team.
Requirements
- Node.js v10 or higher
Getting Started
This package is available in the Node Package Repository and can be easily installed with npm or yarn.
$ npm i @slimio/wcwidth
# or
$ yarn add @slimio/wcwidth
Usage example
const wcwidth = require("@slimio/wcwidth");
'한'.length // => 1
wcwidth('한'); // => 2
'한글'.length // => 2
wcwidth('한글'); // => 4
wcwidth()
and its string version, wcswidth()
are defined by IEEE Std
1002.1-2001, a.k.a. POSIX.1-2001, and return the number of columns used
to represent the given wide character and string.
Markus's implementation assumes the wide character given to those functions to be encoded in ISO 10646, which is almost true for JavaScript's characters.
API
TBC
Dependencies
This project have no dependencies.
License
MIT