@topcli/wcwidth

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 [e-mail] (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).

Requirements

• Node.js v14 or higher

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @topcli/wcwidth
# or
$ yarn add @topcli/wcwidth

Usage example

import wcwidth from "@topcli/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.

Further explaination here

API

TBC

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Gentilhomme 💻 📖 👀 🛡️ 🐛

License

MIT