linegauge

linegauge — how much of a terminal line a string occupies, and how to fold it.

import width from 'linegauge';
import { lineCount, measure, width, … } from 'linegauge';

FunctionsCopy Anchor Link

defaultCopy Anchor Link

The default export, declared as width.

How many terminal columns input occupies once its escape sequences are removed — string-width 9's answer, under its option names and defaults (WidthOptions). Non-strings measure 0.

function width(input: string, options?: WidthOptions): number;

Returns number

lineCountCopy Anchor Link

Lines a string occupies in a terminal columns wide, each measured by width. An empty line still occupies one.

function lineCount(text: string, columns: number): number;

Returns number

measureCopy Anchor Link

Columns a string of plain text occupies — no escape scan.

function measure(text: string, ambiguousIsWide?: boolean): number;

Returns number

widthCopy Anchor Link

How many terminal columns input occupies once its escape sequences are removed — string-width 9's answer, under its option names and defaults (WidthOptions). Non-strings measure 0.

function width(input: string, options?: WidthOptions): number;

Returns number

Re-exportedCopy Anchor Link

Documented on the page of the entry point that declares them.