is-fullwidth-code-point

What is is-fullwidth-code-point?

The is-fullwidth-code-point npm package is used to determine if a given Unicode code point will be displayed as full-width in a terminal. Full-width characters take up two spaces in a monospace grid, as opposed to half-width characters that take up one space. This is particularly useful when dealing with CJK (Chinese, Japanese, and Korean) characters, emojis, or other symbols that may not conform to the standard width of ASCII characters.

What are is-fullwidth-code-point's main functionalities?

Check if a code point is full-width

This feature allows you to check if a single Unicode code point is considered full-width. The function returns a boolean value.

const isFullwidthCodePoint = require('is-fullwidth-code-point');

console.log(isFullwidthCodePoint('あ'.codePointAt(0))); // true
console.log(isFullwidthCodePoint('A'.codePointAt(0))); // false

Other packages similar to is-fullwidth-code-point

string-width

This package calculates and returns the width of a string by considering full-width characters and ANSI escape codes. It uses is-fullwidth-code-point internally to determine the width of individual characters.

wcwidth

Based on the wcwidth implementation in C, this package provides a JavaScript function to get the printable width of a string on the terminal. It is similar to is-fullwidth-code-point but works at the string level rather than individual code points.

eastasianwidth

This package categorizes Unicode characters according to their East Asian Width properties, which can be used to determine if characters are full-width, half-width, wide, narrow, ambiguous, or neutral. It provides more detailed information compared to is-fullwidth-code-point.

README

is-fullwidth-code-point

Check if the character represented by a given Unicode code point is fullwidth

Install

npm install is-fullwidth-code-point

Usage

import isFullwidthCodePoint from 'is-fullwidth-code-point';

isFullwidthCodePoint('谢'.codePointAt(0));
//=> true

isFullwidthCodePoint('a'.codePointAt(0));
//=> false

API

isFullwidthCodePoint(codePoint)

codePoint

Type: number

The code point of a character.