console-toolkit 1.2.15 → 1.3.0

package/README.md

@@ -132,6 +132,7 @@ BSD 3-Clause License
 
 ## Release history
 
+- 1.3.0 _Spinner API split (`tick`/`getFrame`/`nextFrame`), JSDoc removed from JS files, minor fixes._
 - 1.2.15 _TypeScript 6.0 compatibility, updated dev deps, CI, license year._
 - 1.2.14 _Updated dev deps._
 - 1.2.13 _Fixed spinner .d.ts export, added TS type tests, stricter type checking, updated dev deps._
@@ -151,3 +152,5 @@ BSD 3-Clause License
 - 1.1.1 _Minor bugfixes in `Table`, some improvements, updated deps._
 - 1.1.0 _Minor improvements, enhanced `Writer` and `Updater`._
 - 1.0.0 _Initial release._
+
+The full release notes are in the wiki: [Release notes](https://github.com/uhop/console-toolkit/wiki/Release-notes).

package/llms-full.txt

@@ -165,8 +165,13 @@ class Panel {
 }
 
 function toPanel(s: any, options?: object): Panel;  // Alias for Panel.make()
+
+// Sentinel character ('\x07' BELL) used by Panel.put() to mark empty cells.
+const EMPTY_CELL_SENTINEL: string;
 ```
 
+When placing text via `panel.put()`, characters matching `emptySymbol` (default `EMPTY_CELL_SENTINEL`) become empty cells. The rendering character for empty cells is set later via `toStrings({emptySymbol})`.
+
 ---
 
 ## Module: Style (`console-toolkit/style`)
@@ -399,14 +404,69 @@ import theme from 'console-toolkit/themes/blocks/unicode-thin.js';
 
 ## Package: spinner (`console-toolkit/spinner`)
 
+Spinners and updatable text components. Two layers:
+
+- `SpinnerBase` / `Spinner` — frame-driven animations. Split API (since 1.3.0): `tick()` advances state, `getFrame()` reads current frame, `nextFrame()` is the convenience combo (`tick()` + `getFrame()`).
+- `spin` — tagged template literal that composes a `SpinnerBase`-shaped object from a template containing nested spinners, arrays, and state-aware functions.
+
 ```ts
-import spin from 'console-toolkit/spinner';
+import spin, {Spinner, SpinnerBase} from 'console-toolkit/spinner';
+
+class SpinnerBase {
+  active: boolean;
+  paused: boolean;
+  finished: boolean;
+  frameIndex: number;
 
-const stop = spin(message, options?);
-// ... do async work ...
-stop();
+  readonly isStarted: boolean;
+  readonly isActive: boolean;
+  readonly isFinished: boolean;
+  state: '' | 'active' | 'paused' | 'finished';
+
+  reset(): void;
+  nextFrameIndex(length: number): number;
+
+  tick(): this;            // advance internal state by one step (state-aware)
+  getFrame(): string;      // read current frame, no mutation
+  nextFrame(): string;     // tick() + getFrame()
+}
+
+interface SpinnerDefinition {
+  frames?: string[];       // active-state frames (default: braille spinner)
+  notStarted?: string[];   // not-started frames (default: [' '])
+  finished?: string[];     // finished frames (default: ['✓'])
+}
+
+class Spinner extends SpinnerBase {
+  spinner: Required<SpinnerDefinition>;
+  constructor(spinnerDefinition?: SpinnerDefinition, isStarted?: boolean);
+  tick(): this;
+  getFrame(): string;
+}
+
+// Tagged template — composes nested Spinners, arrays, and (state) => string functions.
+function spin(strings: TemplateStringsArray, ...args: unknown[]): SpinnerBase;
 ```
 
+Usage with `Updater` (auto-refreshing terminal output):
+
+```js
+import spin, {Spinner} from 'console-toolkit/spinner';
+import {bouncingBall} from 'console-toolkit/spinner/spinners.js';
+import Updater from 'console-toolkit/output/updater.js';
+
+const spinner = spin`Loading: [${new Spinner()}], ${new Spinner(bouncingBall)}, state: ${state => state}`;
+const updater = new Updater(spinner);
+if (updater.writer.isTTY) {
+  updater.update();
+  updater.startRefreshing();
+}
+// ... async work ...
+await updater.final();
+```
+
+`Updater` calls `nextFrame()` on its target if available, falling back to `getFrame()`. Use `nextFrame()` directly when driving a spinner from your own render loop; use `getFrame()` to peek without advancing.
+
 ---
 
 ## Package: ansi (`console-toolkit/ansi`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "console-toolkit",
-  "version": "1.2.15",
+  "version": "1.3.0",
   "description": "Toolkit to produce a fancy console output (boxes, tables, charts, colors).",
   "type": "module",
   "main": "src/index.js",
@@ -85,12 +85,12 @@
     ]
   },
   "devDependencies": {
-    "@types/node": "^25.5.0",
+    "@types/node": "^25.6.0",
     "emoji-regex": "^10.6.0",
     "get-east-asian-width": "^1.5.0",
-    "prettier": "^3.8.1",
-    "tape-six": "^1.7.13",
-    "tape-six-proc": "^1.2.8",
-    "typescript": "^6.0.2"
+    "prettier": "^3.8.3",
+    "tape-six": "^1.9.0",
+    "tape-six-proc": "^1.2.9",
+    "typescript": "^6.0.3"
   }
 }

package/src/alphanumeric/arrows.js

@@ -1,10 +1,6 @@
-/** Direction index for left-pointing arrows. */
 export const LEFT = 0,
-  /** Direction index for up-pointing arrows. */
   UP = 1,
-  /** Direction index for right-pointing arrows. */
   RIGHT = 2,
-  /** Direction index for down-pointing arrows. */
   DOWN = 3;
 
 const toSymbol = (...args) => args.map(x => (typeof x == 'number' ? String.fromCodePoint(x) : x));
@@ -13,42 +9,23 @@ const makeArrowsH = codePoint => toSymbol(codePoint, ' ', codePoint + 1, ' ');
 
 // Arrows
 
-/** Simple arrows [left, up, right, down]. */
 export const simple = makeArrows(0x2190);
-/** Arrows with stroke [left, up, right, down]. */
 export const withStroke = makeArrowsH(0x219a);
-/** Wave arrows [left, up, right, down]. */
 export const wave = makeArrowsH(0x219c);
-/** Two-headed arrows [left, up, right, down]. */
 export const twoHeaded = makeArrows(0x219e);
-/** Arrows with tail [left, up, right, down]. */
 export const withTail = makeArrowsH(0x21a2);
-/** Arrows from bar [left, up, right, down]. */
 export const fromBar = makeArrows(0x21a4);
-/** Arrows with loop [left, up, right, down]. */
 export const withLoop = makeArrowsH(0x21ab);
-/** Double arrows [left, up, right, down]. */
 export const double = makeArrows(0x21d0);
-/** Triple arrows [left, up, right, down]. */
 export const triple = makeArrowsH(0x21da);
-/** Squiggle arrows [left, up, right, down]. */
 export const squiggle = makeArrowsH(0x21dc);
-/** Dashed arrows [left, up, right, down]. */
 export const dashed = makeArrows(0x21e0);
-/** Arrows to bar [left, up, right, down]. */
 export const toBar = makeArrowsH(0x21e4);
-/** White (outline) arrows [left, up, right, down]. */
 export const white = makeArrows(0x21e6);
-/** Arrows with vertical stroke [left, up, right, down]. */
 export const withVStroke = makeArrowsH(0x21f7);
-/** Arrows with double vertical stroke [left, up, right, down]. */
 export const withDoubleVStroke = makeArrowsH(0x21fa);
-/** Open-headed arrows [left, up, right, down]. */
 export const openHeaded = makeArrowsH(0x21fd);
 
-/** Arrows with barb up [left, up, right, down]. */
 export const withBarbUp = toSymbol(0x21bc, 0x21be, 0x21c1, 0x21c3);
-/** Arrows with barb down [left, up, right, down]. */
 export const withBarbDown = toSymbol(0x21bd, 0x21bf, 0x21c0, 0x21c2);
-/** Double arrows with stroke [left, up, right, down]. */
 export const doubleWithStroke = toSymbol(0x21cd, ' ', 0x21cf, ' ');

package/src/alphanumeric/fractions.js

@@ -1,7 +1,3 @@
-/** All available Unicode fraction characters, sorted by value.
- * Each entry has `numerator`, `denominator`, `symbol`, and `value` properties.
- * @type {{numerator: number, denominator: number, symbol: string, value: number}[]}
- */
 export const fractions = [
   [1, 7, '\u2150'],
   [1, 9, '\u2151'],
@@ -28,25 +24,10 @@ export const fractions = [
 
 const pick = denominator => fractions.filter(x => !(denominator % x.denominator));
 
-/** Unicode fraction characters with denominator 3.
- * @type {import('./fractions.js').Fraction[]}
- */
 export const thirds = pick(3);
-/** Unicode fraction characters with denominator 4.
- * @type {import('./fractions.js').Fraction[]}
- */
 export const quarters = [{numerator: 0, denominator: 4, symbol: '0', value: 0}, ...pick(4)];
-/** Unicode fraction characters with denominator 5.
- * @type {import('./fractions.js').Fraction[]}
- */
 export const fifths = [{numerator: 0, denominator: 5, symbol: '0', value: 0}, ...pick(5)];
-/** Unicode fraction characters with denominator 6.
- * @type {import('./fractions.js').Fraction[]}
- */
 export const sixths = pick(6);
-/** Unicode fraction characters with denominator 8.
- * @type {import('./fractions.js').Fraction[]}
- */
 export const eighths = [{numerator: 0, denominator: 8, symbol: '0', value: 0}, ...pick(8)];
 
 export {quarters as fourths};
@@ -91,41 +72,11 @@ const findSymbol = (fractions, value, useFractionForZero) => {
   return (int || '') + chosen.symbol;
 };
 
-/** Finds the closest Unicode fraction symbol for a given value.
- * @param {number} value - The value to approximate.
- * @param {boolean} [useFractionForZero] - If true, use a fraction symbol even for zero.
- * @returns {string} The integer part plus the closest fraction symbol.
- */
 export const getFraction = (value, useFractionForZero) => findSymbol(fractions, value, useFractionForZero);
-/** Finds the closest Unicode fraction symbol from thirds.
- * @param {number} value - The value to approximate.
- * @param {boolean} [useFractionForZero] - If true, use a fraction symbol even for zero.
- * @returns {string} The integer part plus the closest fraction symbol.
- */
 export const getThirds = (value, useFractionForZero) => findSymbol(thirds, value, useFractionForZero);
-/** Finds the closest Unicode fraction symbol from quarters.
- * @param {number} value - The value to approximate.
- * @param {boolean} [useFractionForZero] - If true, use a fraction symbol even for zero.
- * @returns {string} The integer part plus the closest fraction symbol.
- */
 export const getQuarters = (value, useFractionForZero) => findSymbol(quarters, value, useFractionForZero);
-/** Finds the closest Unicode fraction symbol from fifths.
- * @param {number} value - The value to approximate.
- * @param {boolean} [useFractionForZero] - If true, use a fraction symbol even for zero.
- * @returns {string} The integer part plus the closest fraction symbol.
- */
 export const getFifths = (value, useFractionForZero) => findSymbol(fifths, value, useFractionForZero);
-/** Finds the closest Unicode fraction symbol from sixths.
- * @param {number} value - The value to approximate.
- * @param {boolean} [useFractionForZero] - If true, use a fraction symbol even for zero.
- * @returns {string} The integer part plus the closest fraction symbol.
- */
 export const getSixths = (value, useFractionForZero) => findSymbol(sixths, value, useFractionForZero);
-/** Finds the closest Unicode fraction symbol from eighths.
- * @param {number} value - The value to approximate.
- * @param {boolean} [useFractionForZero] - If true, use a fraction symbol even for zero.
- * @returns {string} The integer part plus the closest fraction symbol.
- */
 export const getEighths = (value, useFractionForZero) => findSymbol(eighths, value, useFractionForZero);
 
 export {getQuarters as getFourths};

package/src/alphanumeric/number-formatters.js

@@ -3,12 +3,6 @@
 const units = ['s', 'ms', 'μs', 'ns', 'ps'],
   unicodeUnits = ['s', '㎳', '㎲', '㎱', '㎰'];
 
-/** Prepares a time format configuration for a set of values.
- * @param {number[]} values - Array of time values.
- * @param {number} [scale=1] - Scale factor.
- * @param {boolean} [useUnicode] - If true, use Unicode unit symbols.
- * @returns {{scale: number, precision: number, unit: string}} Format configuration.
- */
 export const prepareTimeFormat = (values, scale = 1, useUnicode) => {
   let mx = -1000,
     mn = 1000;
@@ -28,11 +22,6 @@ export const prepareTimeFormat = (values, scale = 1, useUnicode) => {
   return {scale, precision: digits - mx, unit: (useUnicode ? unicodeUnits : units)[i]};
 };
 
-/** Formats a time value using a prepared format configuration.
- * @param {number} value - The time value.
- * @param {{scale: number, precision: number, unit: string}} format - Format from `prepareTimeFormat`.
- * @returns {string} Formatted time string.
- */
 export const formatTime = (value, format) => {
   let result = (value * format.scale).toFixed(format.precision);
   if (format.precision > 0 && !format.keepFractionAsIs) result = result.replace(/\.0+$/, '');
@@ -52,28 +41,11 @@ const putCommasIn = (s, options) => {
   );
 };
 
-/** Formats an integer with optional comma separators and sign.
- * @param {number} value - The integer value.
- * @param {object} [options] - Options.
- * @param {string} [options.comma=','] - Thousands separator.
- * @param {boolean} [options.keepSign] - If true, prefix positive numbers with '+'.
- * @returns {string} Formatted string.
- */
 export const formatInteger = (value, options) =>
   isNaN(value)
     ? ''
     : (value < 0 ? '-' : options?.keepSign ? '+' : '') + putCommasIn(Math.abs(value).toFixed(0), options);
 
-/** Formats a number with optional decimals, comma separators, and sign.
- * @param {number} value - The number.
- * @param {object} [options] - Options.
- * @param {number} [options.decimals=0] - Number of decimal places.
- * @param {string} [options.comma=','] - Thousands separator.
- * @param {string} [options.dot='.'] - Decimal separator.
- * @param {boolean} [options.keepSign] - If true, prefix positive numbers with '+'.
- * @param {boolean} [options.keepFractionAsIs] - If true, don't strip trailing zeros.
- * @returns {string} Formatted string.
- */
 export const formatNumber = (value, options) => {
   if (isNaN(value)) return '';
   const decimals = options?.decimals ?? 0;
@@ -93,11 +65,6 @@ export const formatNumber = (value, options) => {
 const exp = [0, 0, 0, 0, 3, 3, 6, 6, 6, 9, 9, 9, 12];
 const abbr = '***k**M**G**T';
 
-/** Formats a number with SI abbreviations (k, M, G, T).
- * @param {number} value - The number.
- * @param {object} [options] - Options (same as `formatNumber`).
- * @returns {string} Abbreviated formatted string.
- */
 export const abbrNumber = (value, options) => {
   if (isNaN(value)) return '';
   const decimals = options?.decimals ?? 0;
@@ -126,20 +93,9 @@ export const abbrNumber = (value, options) => {
   );
 };
 
-/** Simplifies the exponent notation of a number string.
- * @param {string|number} s - The number or string.
- * @param {object} [options] - Options.
- * @param {boolean} [options.keepExpPlus] - If true, keep the '+' in the exponent.
- * @returns {string} Simplified string.
- */
 export const simplifyExponent = (s, {keepExpPlus} = {}) =>
   String(s).replace(new RegExp('\\.?0*e' + (keepExpPlus ? '' : '\\+?'), 'i'), 'e');
 
-/** Compares two positive numbers and returns a description of their difference.
- * @param {number} a - First value.
- * @param {number} b - Second value.
- * @returns {{less: boolean, equality?: boolean, infinity?: boolean, percentage?: string, ratio?: string}}
- */
 export const compareDifference = (a, b) => {
   // works only on positive numbers
   a = Math.abs(a);

package/src/alphanumeric/roman.js

@@ -24,10 +24,6 @@ const romanGroup = (value, one, five, ten) => {
   return one + ten;
 };
 
-/** Converts a positive integer (1-3999) to a Roman numeral string using ASCII characters.
- * @param {number} value - Integer between 1 and 3999.
- * @returns {string} Roman numeral string.
- */
 export const toRoman = value => {
   value = Math.round(value);
   if (value < 1 || value > 3999)
@@ -86,13 +82,5 @@ const toRomanUnicodeFn = (roman, L, C, D, M) => value => {
   return result.reverse().join('');
 };
 
-/** Converts a positive integer (1-3999) to a Roman numeral string using Unicode Roman numeral characters.
- * @param {number} value - Integer between 1 and 3999.
- * @returns {string} Unicode Roman numeral string.
- */
 export const toRomanUnicode = toRomanUnicodeFn(roman, upperL, upperC, upperD, upperM);
-/** Converts a positive integer (1-3999) to a lowercase Unicode Roman numeral string.
- * @param {number} value - Integer between 1 and 3999.
- * @returns {string} Lowercase Unicode Roman numeral string.
- */
 export const toRomanLowerUnicode = toRomanUnicodeFn(romanLower, lowerL, lowerC, lowerD, lowerM);

package/src/alphanumeric/unicode-cultural-numbers.js

@@ -1,6 +1,5 @@
 import {SymbolRange} from './utils.js';
 
-/** Transcode tables for cultural number systems, mapping ASCII digits to their Unicode equivalents. */
 export const transcodeTables = {
   arabicIndic: new SymbolRange('٠'),
   arabicIndicExtended: new SymbolRange('۰'),

package/src/alphanumeric/unicode-letters.js

@@ -5,7 +5,6 @@ const range = (fromCapital, fromSmall) =>
     x => x
   );
 
-/** Transcode tables for mathematical and decorative letter styles. */
 export const transcodeTables = {
   bold: range('\u{1D400}', '\u{1D41A}'),
   italic: range('\u{1D434}', '\u{1D44E}'),
@@ -57,13 +56,6 @@ transcodeTables.script[1].overlay = {e: '\u{212F}', g: '\u{210A}', o: '\u{2134}'
 
 // API
 
-/** Transcodes a string to a Unicode letter style.
- * @param {string} s - The string to transcode.
- * @param {string|import('./utils.js').SymbolRange[]} name - Style name (key of `transcodeTables`) or an array of SymbolRanges.
- * @param {object} [options] - Options.
- * @param {string} [options.missing] - Replacement for unmapped characters.
- * @returns {string} The transcoded string.
- */
 export const transcode = (s, name, options) => {
   let tables = typeof name == 'string' ? transcodeTables[name] : name;
   if (!tables) throw new Error(`There is no transcode table "${name}"`);

package/src/alphanumeric/unicode-numbers.js

@@ -1,7 +1,6 @@
 import {SymbolRange, transcode as internalTranscode} from './utils.js';
 import {minus, multiplication, superscriptPlus, superscriptMinus} from '../symbols.js';
 
-/** Transcode tables for Unicode number styles and embellishments. */
 export const transcodeTables = {
   // Enclosed Alphanumeric
   circled: new SymbolRange('①', 1, 20),
@@ -51,38 +50,18 @@ transcodeTables.superscript.overlay = {1: '¹', 2: '²', 3: '³'};
 
 // API
 
-/** Transcodes a string of digits to a Unicode number style.
- * @param {string} s - The digit string to transcode.
- * @param {string|import('./utils.js').SymbolRange} name - Style name (key of `transcodeTables`) or a SymbolRange.
- * @param {object} [options] - Options.
- * @param {string} [options.missing] - Replacement for unmapped characters.
- * @returns {string} The transcoded string.
- */
 export const transcode = (s, name, options) => {
   const table = typeof name == 'string' ? transcodeTables[name] : name;
   if (!table) throw new Error(`There is no transcode table "${name}"`);
   return internalTranscode(s, table, options);
 };
 
-/** Replaces digit-punctuation pairs with Unicode enclosed digits.
- * @param {string} s - The string containing digits with commas/dots.
- * @param {object} [options] - Options for surrounding text.
- * @param {string} [options.addBefore=''] - String to add before a digit.
- * @param {string} [options.addAfter=' '] - String to add after a digit.
- * @returns {string} The string with Unicode punctuation replacements.
- */
 export const numberPunctuation = (s, {addBefore = '', addAfter = ' '} = {}) =>
   s.replace(
     /(\d)([\,\.])/g,
     (_, d, p) => addBefore + transcodeTables[p === '.' ? 'dots' : 'commas'].transcode(d) + addAfter
   );
 
-/** Converts scientific notation to Unicode superscript exponent form.
- * @param {string} s - The number string in scientific notation (e.g., '1.5e10').
- * @param {object} [options] - Options.
- * @param {boolean} [options.useSpecialMinus] - If true, use a special math minus symbol.
- * @returns {string} The formatted string with Unicode superscripts.
- */
 export const numberExponent = (s, {useSpecialMinus} = {}) => {
   const r = /^([+-]?)([^e]+)e([+-]?)(.+)$/i.exec(s);
   return r

package/src/alphanumeric/utils.js

@@ -1,13 +1,4 @@
-/** Maps a range of numeric values to Unicode code points for transcoding digits/letters.
- * Supports overlays for custom symbol replacements.
- */
 export class SymbolRange {
-  /**
-   * @param {string} fromSymbol - The Unicode character corresponding to the `from` value.
-   * @param {number} [from=0] - Start of the range.
-   * @param {number} [to=9] - End of the range (inclusive).
-   * @param {string} [inputBase='0'] - The input character corresponding to 0.
-   */
   constructor(fromSymbol, from = 0, to = 9, inputBase = '0') {
     this.from = from;
     this.to = to;
@@ -15,10 +6,6 @@ export class SymbolRange {
     this.inputBase = inputBase.codePointAt(0);
     this.overlay = null;
   }
-  /** Gets the transcoded symbol for a value or character.
-   * @param {number|string} i - Numeric index or input character.
-   * @returns {string|false} The transcoded symbol, or false if out of range.
-   */
   get(i) {
     if (this.overlay) {
       const result =
@@ -32,24 +19,11 @@ export class SymbolRange {
     }
     return this.from <= i && i <= this.to && String.fromCodePoint(this.base + i);
   }
-  /** Transcodes a string by replacing each character with its mapped symbol.
-   * @param {string} s - The string to transcode.
-   * @param {object} [options] - Options.
-   * @param {string} [options.missing] - Replacement for unmapped characters.
-   * @returns {string} The transcoded string.
-   */
   transcode(s, {missing} = {}) {
     return s.replace(/./g, missing ? m => this.get(m) || missing : m => this.get(m) || m);
   }
 }
 
-/** Transcodes a string using one or more lookup tables.
- * @param {string} s - The string to transcode.
- * @param {Function|object|Array} tables - A function, object, SymbolRange, or array of them.
- * @param {object} [options] - Options.
- * @param {string} [options.missing] - Replacement for unmapped characters.
- * @returns {string} The transcoded string.
- */
 export const transcode = (s, tables, {missing} = {}) => {
   let fn;
   if (typeof tables == 'function') {

package/src/ansi/csi.js

@@ -7,9 +7,6 @@
 export * from './sgr.js';
 
 // matcher
-/** RegExp matching CSI (Control Sequence Introducer) escape sequences with parameter, intermediate, and final byte groups.
- * @type {RegExp}
- */
 export const matchCsi = /\x1B\[([\x30-\x3F]*)([\x20-\x2F]*)([\x40-\x7E])/g;
 
 const CSI = '\x1B[';
@@ -29,52 +26,14 @@ export const CURSOR_RESTORE_POS = CSI + 'u';
 export const CURSOR_NORMAL = CSI + '?25h';
 export const CURSOR_INVISIBLE = CSI + '?25l';
 
-/** Moves the cursor up by `n` rows.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const cursorUp = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'A';
-/** Moves the cursor down by `n` rows.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const cursorDown = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'B';
-/** Moves the cursor forward by `n` columns.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const cursorForward = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'C';
-/** Moves the cursor back by `n` columns.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const cursorBack = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'D';
-/** Moves cursor to beginning of line `n` lines down.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const cursorNextLine = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'E';
-/** Moves cursor to beginning of line `n` lines up.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const cursorPrevLine = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'F';
-/** Moves cursor to column `n`.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const cursorColumn = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'G';
-/** Sets the cursor to row `n`, column `m` (1-based).
- * @param {number} n - Row.
- * @param {number} m - Column.
- * @returns {string} CSI sequence.
- */
 export const cursorSetPos = (n, m) => CSI + (n > 1 ? n.toFixed() : '') + ';' + (m > 1 ? m.toFixed() : '') + 'H';
-/** Sets the cursor position (alternative HVP sequence).
- * @param {number} n - Row.
- * @param {number} m - Column.
- * @returns {string} CSI sequence.
- */
 export const cursorSetPosAlt = (n, m) => CSI + (n > 1 ? n.toFixed() : '') + ';' + (m > 1 ? m.toFixed() : '') + 'f'; // HVP
 
 export const CURSOR_RIGHT1 = CURSOR_FORWARD1;
@@ -99,15 +58,7 @@ export const SCREEN_SCROLL_DOWN1 = CSI + 'T';
 export const SCREEN_REPORT_FOCUS_ON = CSI + '?1004h';
 export const SCREEN_REPORT_FOCUS_OFF = CSI + '?1004l';
 
-/** Scrolls the screen up by `n` lines.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const screenScrollUp = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'S';
-/** Scrolls the screen down by `n` lines.
- * @param {number} [n=1]
- * @returns {string} CSI sequence.
- */
 export const screenScrollDown = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'T';
 
 export const WRAPPING_ON = CSI + '=7h';