The alphanumeric package provides utilities for working with numbers, letters and symbols used to improve user experience in the console.

• Utilities:
  • Converting to Roman numbers: alphanumeric/roman.js.
  • Number formatters/humanizers: alphanumeric/number-formatters.js.
  • Special Unicode symbols for well-known fractions: alphanumeric/fractions.js.
  • Transcoding utilities: alphanumeric/utils.js.
• Special symbols:
  • Arrows: alphanumeric/arrows.js.
  • Decorative symbols for Latin letters: alphanumeric/unicode-letters.js.
  • Decorative symbols for numbers: alphanumeric/unicode-numbers.js.
  • Alternative symbols for numbers: alphanumeric/unicode-cultural-numbers.js.

alphanumeric/arrows.js

The alphanumeric/arrows.js module provides constants for arrows and their Unicode symbols. See the file for more details.

Arrows are represented as a four-element array of Unicode symbols. THe module defines the following directional constants to access array elements:

Name	Value
LEFT	0
UP	1
RIGHT	2
DOWN	3

This table was generated by scripts/arrows.js:

╭───────────────────┬─────────╮
│ Name              │ Result  │
├───────────────────┼─────────┤
│ dashed            │ ⇠ ⇡ ⇢ ⇣ │
│ double            │ ⇐ ⇑ ⇒ ⇓ │
│ doubleWithStroke  │ ⇍   ⇏   │
│ fromBar           │ ↤ ↥ ↦ ↧ │
│ openHeaded        │ ⇽   ⇾   │
│ simple            │ ← ↑ → ↓ │
│ squiggle          │ ⇜   ⇝   │
│ toBar             │ ⇤   ⇥   │
│ triple            │ ⇚   ⇛   │
│ twoHeaded         │ ↞ ↟ ↠ ↡ │
│ wave              │ ↜   ↝   │
│ white             │ ⇦ ⇧ ⇨ ⇩ │
│ withBarbDown      │ ↽ ↿ ⇀ ⇂ │
│ withBarbUp        │ ↼ ↾ ⇁ ⇃ │
│ withDoubleVStroke │ ⇺   ⇻   │
│ withLoop          │ ↫   ↬   │
│ withStroke        │ ↚   ↛   │
│ withTail          │ ↢   ↣   │
│ withVStroke       │ ⇷   ⇸   │
╰───────────────────┴─────────╯

alphanumeric/fractions.js

Unicode has special symbols to represent fractions: a half, thirds, quarters, fifths, sixths, eighths, etc. The alphanumeric/fractions.js module provides tables of such symbols and functions, that choose the appropriate symbol for the given fraction. See the file for more details.

Tables

Fractions are represented by an array of objects with the following properties:

• numerator — the numerator of the fraction.
• denominator — the denominator of the fraction.
• symbol — the symbol used to represent the fraction.
• value — the value of the fraction.

Example: {numerator: 1, denominator: 2, symbol: '\u00BD', value: 0.5}.

Available tables:

• fractions — the table of all fraction symbols.
• thirds — the table of all third symbols.
• quarters — the table of all quarter symbols. AKA fourths.
• fifths — the table of all fifth symbols.
• sixths — the table of all sixth symbols.
• eighths — the table of all eighth symbols.

Utilities

All utilities have the following signature: getXXX(fraction, useFractionForZero) and return a string:

• fraction — a number. Its fractional part will be replaced by the closest fraction symbol.
• useFractionForZero — if true, a fractional zero symbol will be used if available.
  • Example: a symbol representing 0/3 will be used if useFractionForZero is true.

The following utilities are available:

• getFraction(fraction, useFractionForZero) — uses the fractions table to find the symbol for the given fraction.
• getThird(fraction, useFractionForZero) — uses the thirds table.
• getQuarter(fraction, useFractionForZero) — uses the quarters table. AKA getFourth().
• getFifth(fraction, useFractionForZero) — uses the fifths table.
• getSixth(fraction, useFractionForZero) — uses the sixths table.
• getEighth(fraction, useFractionForZero) — uses the eighths table.

Example

This table was generated by scripts/fractions.js:

Available fraction symbols

fractions: ↉ ⅒ ⅑ ⅛ ⅐ ⅙ ⅕ ¼ ⅓ ⅜ ⅖ ½ ⅗ ⅝ ⅔ ¾ ⅘ ⅚ ⅞
thirds:    ↉ ⅓ ⅔
quarters:  0 ¼ ½ ¾
fifths:    0 ⅕ ⅖ ⅗ ⅘
sixths:    ↉ ⅙ ⅓ ½ ⅔ ⅚
eighths:   0 ⅛ ¼ ⅜ ½ ⅝ ¾ ⅞

Mapping fractions to symbols

╭───────┬───────────────────────────────────────────────────────────╮
│       │                      Chosen symbols                       │
│ Value ├────────┬──────────┬────────┬────────┬─────────┬───────────┤
│       │ Thirds │ Quarters │ Fifths │ Sixths │ Eighths │ Fractions │
├───────┼────────┼──────────┼────────┼────────┼─────────┼───────────┤
│ 1.00  │   1    │    1     │   1    │   1    │    1    │     1     │
│ 1.05  │   1    │    1     │   1    │   1    │    1    │    1⅒     │
│ 1.10  │   1    │    1     │   1⅕   │   1⅙   │   1⅛    │    1⅒     │
│ 1.15  │   1    │    1¼    │   1⅕   │   1⅙   │   1⅛    │    1⅐     │
│ 1.20  │   1⅓   │    1¼    │   1⅕   │   1⅙   │   1¼    │    1⅕     │
│ 1.25  │   1⅓   │    1¼    │   1⅕   │   1⅓   │   1¼    │    1¼     │
│ 1.30  │   1⅓   │    1¼    │   1⅖   │   1⅓   │   1¼    │    1⅓     │
│ 1.35  │   1⅓   │    1¼    │   1⅖   │   1⅓   │   1⅜    │    1⅓     │
│ 1.40  │   1⅓   │    1½    │   1⅖   │   1⅓   │   1⅜    │    1⅖     │
│ 1.45  │   1⅓   │    1½    │   1⅖   │   1½   │   1½    │    1⅖     │
│ 1.50  │   1⅔   │    1½    │   1⅖   │   1½   │   1½    │    1½     │
│ 1.55  │   1⅔   │    1½    │   1⅗   │   1½   │   1½    │    1⅗     │
│ 1.60  │   1⅔   │    1½    │   1⅗   │   1⅔   │   1⅝    │    1⅗     │
│ 1.65  │   1⅔   │    1¾    │   1⅗   │   1⅔   │   1⅝    │    1⅔     │
│ 1.70  │   1⅔   │    1¾    │   1⅘   │   1⅔   │   1¾    │    1⅔     │
│ 1.75  │   1⅔   │    1¾    │   1⅘   │   1⅔   │   1¾    │    1¾     │
│ 1.80  │   1⅔   │    1¾    │   1⅘   │   1⅚   │   1¾    │    1⅘     │
│ 1.85  │   2    │    1¾    │   1⅘   │   1⅚   │   1⅞    │    1⅚     │
│ 1.90  │   2    │    2     │   1⅘   │   1⅚   │   1⅞    │    1⅞     │
│ 1.95  │   2    │    2     │   2    │   2    │    2    │     2     │
│ 2.00  │   2    │    2     │   2    │   2    │    2    │     2     │
╰───────┴────────┴──────────┴────────┴────────┴─────────┴───────────╯

alphanumeric/number-formatters.js

The alphanumeric/number-formatters.js module provides functions to format numbers. See the file for more details.

The following utilities are available:

• formatTime() — format time values. It selects a time unit.
• prepareTimeFormat() — prepare time format for formatTime().
• formatInteger() — format integer values. It adds thousands separators.
• formatNumber() — format floating point values. It adds thousands separators and adds decimals if necessary.
• abbrNumber() — abbreviate numbers. It uses standard number units: k for thousands, M for millions, and G for billions, etc.
• simplifyExponent() — simplify exponential notation. It removes unnecessary zeros after the decimal point.
• compareDifference() — compare two numbers and return a humanized difference in percentage, as a ratio, etc.

Function prepareTimeFormat()

prepareTimeFormat(values, scale = 1, useUnicode = false) prepares time format for formatTime(). It takes an array of time values and finds a common time format so they can be directly comparable.

The following parameters are supported:

• values — an array of time values.
• scale — the initial scale factor. Defaults to 1 (seconds).
  • Date.now() returns the number of milliseconds. In this case the scale should be set to 1000.
• useUnicode — if true, special Unicode unit symbols will be used. Otherwise, ASCII unit names will be used. Defaults to false.

It returns an object with the following properties:

• scale — the common scale factor.
• precision — the number of digits after the decimal point.
• unit — the time unit as a string.

Example

import {prepareTimeFormat} from 'console-toolkit/alphanumeric/number-formatters.js';

const fmt1 = prepareTimeFormat([0.000002, 0.000005, 0.000020]);
// {scale: 1000000, precision: 1, unit: 'μs'}

const fmt2 = prepareTimeFormat([2, 5, 20], 1000, true);
// {scale: 1, precision: 1, unit: '㎳'}

Function formatTime()

formatTime(value, format) formats a time value returning a string:

• value — the time value.
• format — the time format. See prepareTimeFormat() for details.
  • It implements additional properties:
    • keepFractionAsIs — keeps fractional part as is if true. Otherwise, it removes trailing zeros and, if warranted, the decimal point. Defaults to false.

The definition of the function explains how format is used the best:

const formatTime = (value, format) => {
  let result = (value * format.scale).toFixed(format.precision);
  if (format.precision > 0 && !format.keepFractionAsIs)
    result = result.replace(/\.0+$/, '');
  return result + format.unit;
};

Example

import {formatTime, prepareTimeFormat} from 'console-toolkit/alphanumeric/number-formatters.js';

const fmt = prepareTimeFormat([2, 3, 20], 1000);

console.log(formatTime(20, fmt)); // 20ms

Function formatInteger()

formatInteger(value, options) formats an integer value returning a string:

• value — the integer value.
• options — an object with the following properties:
  • keepSign — forces + sign for positive numbers if true. Defaults to false.
  • comma — a thousand separator. Defaults to ','.

Example

import {formatInteger} from 'console-toolkit/alphanumeric/number-formatters.js';

console.log(formatInteger(123456789)); // 123,456,789

Function formatNumber()

formatNumber(value, options) formats a real number value using a fixed-point notation returning a string:

• value — the real number value.
• options — an object with the following properties:
  • decimals — the number of decimals. Defaults to 0.
  • keepSign — forces + sign for positive numbers if true. Defaults to false.
  • keepFractionAsIs — keeps fractional part as is if true. Otherwise, it removes trailing zeros and, if warranted, the decimal point. Defaults to false.
  • dot — the decimal point symbol. Defaults to ..
  • comma — a thousand separator. Defaults to ','.

The integer part of a number is formatted using formatInteger() with the same options.

Example

import {formatNumber} from 'console-toolkit/alphanumeric/number-formatters.js';

console.log(formatNumber(1234.78956, {decimals: 3})); // 1,234.79
console.log(formatNumber(1234.78956, {
  decimals: 3, keepFractionAsIs: true})); // 1,234.790

Function abbrNumber()

abbrNumber(value, options) abbreviates a number using standard notation of k, M, G, or T returning a string:

• value — the number value.
• options — an object with the following properties:
  • decimals — the number of decimals. Defaults to 0.
  • keepSign — forces + sign for positive numbers if true. Defaults to false.
  • keepFractionAsIs — keeps fractional part as is if true. Otherwise, it removes trailing zeros and, if warranted, the decimal point. Defaults to false.
  • dot — the decimal point symbol. Defaults to ..
  • comma — a thousand separator. Defaults to ','.

Example

import {abbrNumber} from 'console-toolkit/alphanumeric/number-formatters.js';

console.log(abbrNumber(123));        // 123
console.log(abbrNumber(1234));       // 1,234
console.log(abbrNumber(12345));      // 12k
console.log(abbrNumber(123456));     // 123k
console.log(abbrNumber(1234567));    // 1M
console.log(abbrNumber(12345678));   // 12M
console.log(abbrNumber(123456789));  // 123M
console.log(abbrNumber(1234567890)); // 1G

console.log(abbrNumber(123, {decimals: 1}));        // 123
console.log(abbrNumber(1234, {decimals: 1}));       // 1,234
console.log(abbrNumber(12345, {decimals: 1}));      // 12.3k
console.log(abbrNumber(123456, {decimals: 1}));     // 123.5k
console.log(abbrNumber(1234567, {decimals: 1}));    // 1.2M
console.log(abbrNumber(12345678, {decimals: 1}));   // 12.3M
console.log(abbrNumber(123456789, {decimals: 1}));  // 123.5M
console.log(abbrNumber(1234567890, {decimals: 1})); // 1.2G

Function simplifyExponent()

simplifyExponent(value, options) simplifies an exponent by removing trailing zeros in the fractional part and removing a plus sign in the exponent returning the result as a string:

• value — a number value or a string representing a number in an exponent notation.
• options — an object with the following properties:
  • keepExpPlus — forces + sign for positive exponents if true. Defaults to false.

Example

import {simplifyExponent} from 'console-toolkit/alphanumeric/number-formatters.js';

console.log((2e99).toExponential(3));                   // 2.000e+99
console.log(simplifyExponent((2e99).toExponential(3))); // 2e99
console.log(
  simplifyExponent((2e99).toExponential(3), {keepExpPlus: true}})); // 2e+99

Function compareDifference()

compareDifference(a, b) compares two numbers in a "human" way. It returns an object with the following properties:

• less — true if a is smaller than b.
• Other properties are mutually exclusive:
  • infinity — true if the smaller number is infinitely smaller than the bigger number.
  • equality — true if the numbers are equal within 0.00001%.
  • percentage — the difference in percentage formatted using formatNumber().
  • ratio — the difference in ratio formatted using formatNumber().

percentage is calculated as 100 * Math.abs(b - a) / a.

ratio is calculated as b / a, where a is the smaller number.

Example

import {compareDifference} from 'console-toolkit/alphanumeric/number-formatters.js';

const announce = result => {
  if (result.equality) return 'equal to';
  if (result.infinity) return `infinitely ${result.less ? 'smaller' : 'bigger'} than`;
  if (result.percentage) return `${result.percentage}% ${result.less ? 'smaller' : 'bigger'} than`;
  if (result.ratio) return `${result.ratio}x ${result.less ? 'smaller' : 'bigger'} than`;
  return 'cannot be compared';
};

const cmp = (a, b) => {
  const result = compareDifference(a, b);
  console.log(a, 'is', announce(result), b);
};

cmp(98, 130); // 98 is 32.7% smaller than 130
cmp(198, 15); // 198 is 13.2x bigger than 15

alphanumeric/roman.js

The alphanumeric/roman.js module provides utilities to convert integers to Roman numbers. See the file for more details.

The utilities work with integer numbers from 1 to 3,999.

Function toRoman()

toRoman(value) converts an integer number to a Roman number string using uppercase letters.

Example

import {toRoman} from 'console-toolkit/alphanumeric/roman.js';

console.log(toRoman(1));     // I
console.log(toRoman(2));     // II
console.log(toRoman(3));     // III
console.log(toRoman(4));     // IV
console.log(toRoman(5));     // V

console.log(toRoman(1776));  // MDCCLXXVI
console.log(toRoman(2000));  // MM
console.log(toRoman(2024));  // MMXXIV

Function toRomanUnicode()

toRomanUnicode(value) converts an integer number to a Roman number string using uppercase Unicode characters.

Example

import {toRomanUnicode} from 'console-toolkit/alphanumeric/roman.js';

console.log(toRomanUnicode(1));     // Ⅰ
console.log(toRomanUnicode(2));     // Ⅱ
console.log(toRomanUnicode(3));     // Ⅲ
console.log(toRomanUnicode(4));     // Ⅳ
console.log(toRomanUnicode(5));     // Ⅴ

console.log(toRomanUnicode(1776));  // ⅯⅮⅭⅭⅬⅩⅩⅥ
console.log(toRomanUnicode(2000));  // ⅯⅯ
console.log(toRomanUnicode(2024));  // ⅯⅯⅩⅩⅣ

Function toRomanLowerUnicode()

toRomanLowerUnicode(value) converts an integer number to a Roman number string using lowercase Unicode characters.

alphanumeric/unicode-letters.js

The alphanumeric/unicode-letters.js module provide tables of Unicode symbols for variously decorated Latin characters. See the file for more details.

Function transcode()

transcode(text, table, options) transcodes the text using the specified table returning a new string:

• text — the text to be transcoded.
• table — the table to be used for transcoding. It can be a name of a table, which is defined in this module, as a string, or a table object itself.
• options — an object with the following properties:
  • missing — if specified it will be a character to be used in place of characters in the text that are not found in the table. Otherwise, a character is left as is.

Tables

The module defines many tables. The following sample table was generated by scripts/letters.js (the output depends on symbols available in the system, run the utility yourself to see the exact result):

╭─────────────────────┬────────────────────────────╮
│ Name                │ Result                     │
├─────────────────────┼────────────────────────────┤
│ pattern             │ ABCDEFGHIJKLMNOPQRSTUVWXYZ │
│                     │ abcdefghijklmnopqrstuvwxyz │
├─────────────────────┼────────────────────────────┤
│ bold                │ 𝐀𝐁𝐂𝐃𝐄𝐅𝐆𝐇𝐈𝐉𝐊𝐋𝐌𝐍𝐎𝐏𝐐𝐑𝐒𝐓𝐔𝐕𝐖𝐗𝐘𝐙 │
│                     │ 𝐚𝐛𝐜𝐝𝐞𝐟𝐠𝐡𝐢𝐣𝐤𝐥𝐦𝐧𝐨𝐩𝐪𝐫𝐬𝐭𝐮𝐯𝐰𝐱𝐲𝐳 │
├─────────────────────┼────────────────────────────┤
│ italic              │ 𝐴𝐵𝐶𝐷𝐸𝐹𝐺𝐻𝐼𝐽𝐾𝐿𝑀𝑁𝑂𝑃𝑄𝑅𝑆𝑇𝑈𝑉𝑊𝑋𝑌𝑍 │
│                     │ 𝑎𝑏𝑐𝑑𝑒𝑓𝑔ℎ𝑖𝑗𝑘𝑙𝑚𝑛𝑜𝑝𝑞𝑟𝑠𝑡𝑢𝑣𝑤𝑥𝑦𝑧 │
├─────────────────────┼────────────────────────────┤
│ boldItalic          │ 𝑨𝑩𝑪𝑫𝑬𝑭𝑮𝑯𝑰𝑱𝑲𝑳𝑴𝑵𝑶𝑷𝑸𝑹𝑺𝑻𝑼𝑽𝑾𝑿𝒀𝒁 │
│                     │ 𝒂𝒃𝒄𝒅𝒆𝒇𝒈𝒉𝒊𝒋𝒌𝒍𝒎𝒏𝒐𝒑𝒒𝒓𝒔𝒕𝒖𝒗𝒘𝒙𝒚𝒛 │
├─────────────────────┼────────────────────────────┤
│ sansSerif           │ 𝖠𝖡𝖢𝖣𝖤𝖥𝖦𝖧𝖨𝖩𝖪𝖫𝖬𝖭𝖮𝖯𝖰𝖱𝖲𝖳𝖴𝖵𝖶𝖷𝖸𝖹 │
│                     │ 𝖺𝖻𝖼𝖽𝖾𝖿𝗀𝗁𝗂𝗃𝗄𝗅𝗆𝗇𝗈𝗉𝗊𝗋𝗌𝗍𝗎𝗏𝗐𝗑𝗒𝗓 │
├─────────────────────┼────────────────────────────┤
│ sansSerifBold       │ 𝗔𝗕𝗖𝗗𝗘𝗙𝗚𝗛𝗜𝗝𝗞𝗟𝗠𝗡𝗢𝗣𝗤𝗥𝗦𝗧𝗨𝗩𝗪𝗫𝗬𝗭 │
│                     │ 𝗮𝗯𝗰𝗱𝗲𝗳𝗴𝗵𝗶𝗷𝗸𝗹𝗺𝗻𝗼𝗽𝗾𝗿𝘀𝘁𝘂𝘃𝘄𝘅𝘆𝘇 │
├─────────────────────┼────────────────────────────┤
│ sansSerifItalic     │ 𝘈𝘉𝘊𝘋𝘌𝘍𝘎𝘏𝘐𝘑𝘒𝘓𝘔𝘕𝘖𝘗𝘘𝘙𝘚𝘛𝘜𝘝𝘞𝘟𝘠𝘡 │
│                     │ 𝘢𝘣𝘤𝘥𝘦𝘧𝘨𝘩𝘪𝘫𝘬𝘭𝘮𝘯𝘰𝘱𝘲𝘳𝘴𝘵𝘶𝘷𝘸𝘹𝘺𝘻 │
├─────────────────────┼────────────────────────────┤
│ sansSerifBoldItalic │ 𝘼𝘽𝘾𝘿𝙀𝙁𝙂𝙃𝙄𝙅𝙆𝙇𝙈𝙉𝙊𝙋𝙌𝙍𝙎𝙏𝙐𝙑𝙒𝙓𝙔𝙕 │
│                     │ 𝙖𝙗𝙘𝙙𝙚𝙛𝙜𝙝𝙞𝙟𝙠𝙡𝙢𝙣𝙤𝙥𝙦𝙧𝙨𝙩𝙪𝙫𝙬𝙭𝙮𝙯 │
├─────────────────────┼────────────────────────────┤
│ script              │ 𝒜ℬ𝒞𝒟ℰℱ𝒢ℋℐ𝒥𝒦ℒℳ𝒩𝒪𝒫𝒬ℛ𝒮𝒯𝒰𝒱𝒲𝒳𝒴𝒵 │
│                     │ 𝒶𝒷𝒸𝒹ℯ𝒻ℊ𝒽𝒾𝒿𝓀𝓁𝓂𝓃ℴ𝓅𝓆𝓇𝓈𝓉𝓊𝓋𝓌𝓍𝓎𝓏 │
├─────────────────────┼────────────────────────────┤
│ scriptBold          │ 𝓐𝓑𝓒𝓓𝓔𝓕𝓖𝓗𝓘𝓙𝓚𝓛𝓜𝓝𝓞𝓟𝓠𝓡𝓢𝓣𝓤𝓥𝓦𝓧𝓨𝓩 │
│                     │ 𝓪𝓫𝓬𝓭𝓮𝓯𝓰𝓱𝓲𝓳𝓴𝓵𝓶𝓷𝓸𝓹𝓺𝓻𝓼𝓽𝓾𝓿𝔀𝔁𝔂𝔃 │
├─────────────────────┼────────────────────────────┤
│ fraktur             │ 𝔄𝔅ℭ𝔇𝔈𝔉𝔊ℌℑ𝔍𝔎𝔏𝔐𝔑𝔒𝔓𝔔ℜ𝔖𝔗𝔘𝔙𝔚𝔛𝔜ℨ │
│                     │ 𝔞𝔟𝔠𝔡𝔢𝔣𝔤𝔥𝔦𝔧𝔨𝔩𝔪𝔫𝔬𝔭𝔮𝔯𝔰𝔱𝔲𝔳𝔴𝔵𝔶𝔷 │
├─────────────────────┼────────────────────────────┤
│ frakturBold         │ 𝕬𝕭𝕮𝕯𝕰𝕱𝕲𝕳𝕴𝕵𝕶𝕷𝕸𝕹𝕺𝕻𝕼𝕽𝕾𝕿𝖀𝖁𝖂𝖃𝖄𝖅 │
│                     │ 𝖆𝖇𝖈𝖉𝖊𝖋𝖌𝖍𝖎𝖏𝖐𝖑𝖒𝖓𝖔𝖕𝖖𝖗𝖘𝖙𝖚𝖛𝖜𝖝𝖞𝖟 │
├─────────────────────┼────────────────────────────┤
│ mono                │ 𝙰𝙱𝙲𝙳𝙴𝙵𝙶𝙷𝙸𝙹𝙺𝙻𝙼𝙽𝙾𝙿𝚀𝚁𝚂𝚃𝚄𝚅𝚆𝚇𝚈𝚉 │
│                     │ 𝚊𝚋𝚌𝚍𝚎𝚏𝚐𝚑𝚒𝚓𝚔𝚕𝚖𝚗𝚘𝚙𝚚𝚛𝚜𝚝𝚞𝚟𝚠𝚡𝚢𝚣 │
├─────────────────────┼────────────────────────────┤
│ doubleStruck        │ 𝔸𝔹ℂ𝔻𝔼𝔽𝔾ℍ𝕀𝕁𝕂𝕃𝕄ℕ𝕆ℙℚℝ𝕊𝕋𝕌𝕍𝕎𝕏𝕐ℤ │
│                     │ 𝕒𝕓𝕔𝕕𝕖𝕗𝕘𝕙𝕚𝕛𝕜𝕝𝕞𝕟𝕠𝕡𝕢𝕣𝕤𝕥𝕦𝕧𝕨𝕩𝕪𝕫 │
├─────────────────────┼────────────────────────────┤
│ parens              │ 🄐🄑🄒🄓🄔🄕🄖🄗🄘🄙🄚🄛🄜🄝🄞🄟🄠🄡🄢🄣🄤🄥🄦🄧🄨🄩 │
│                     │ ⒜⒝⒞⒟⒠⒡⒢⒣⒤⒥⒦⒧⒨⒩⒪⒫⒬⒭⒮⒯⒰⒱⒲⒳⒴⒵ │
├─────────────────────┼────────────────────────────┤
│ circled             │ ⒶⒷⒸⒹⒺⒻⒼⒽⒾⒿⓀⓁⓂⓃⓄⓅⓆⓇⓈⓉⓊⓋⓌⓍⓎⓏ │
│                     │ ⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙⓚⓛⓜⓝⓞⓟⓠⓡⓢⓣⓤⓥⓦⓧⓨⓩ │
├─────────────────────┼────────────────────────────┤
│ squared             │ 🄰🄱🄲🄳🄴🄵🄶🄷🄸🄹🄺🄻🄼🄽🄾🄿🅀🅁🅂🅃🅄🅅🅆🅇🅈🅉 │
│                     │ abcdefghijklmnopqrstuvwxyz │
├─────────────────────┼────────────────────────────┤
│ negativeCircled     │ 🅐🅑🅒🅓🅔🅕🅖🅗🅘🅙🅚🅛🅜🅝🅞🅟🅠🅡🅢🅣🅤🅥🅦🅧🅨🅩 │
│                     │ abcdefghijklmnopqrstuvwxyz │
├─────────────────────┼────────────────────────────┤
│ negativeSquared     │ 🅰🅱🅲🅳🅴🅵🅶🅷🅸🅹🅺🅻🅼🅽🅾🅿🆀🆁🆂🆃🆄🆅🆆🆇🆈🆉 │
│                     │ abcdefghijklmnopqrstuvwxyz │
├─────────────────────┼────────────────────────────┤
│ regionalIndicators  │ 🇦🇧🇨🇩🇪🇫🇬🇭🇮🇯🇰🇱🇲🇳🇴🇵🇶🇷🇸🇹🇺🇻🇼🇽🇾🇿 │
│                     │ abcdefghijklmnopqrstuvwxyz │
╰─────────────────────┴────────────────────────────╯

The tables are exposed as the transcodeTables object. Its keys are names of tables and values are table objects.

alphanumeric/unicode-numbers.js

The alphanumeric/unicode-numbers.js module provides tables of Unicode symbols for numbers. It is used mostly to decorate numbers, e.g., as list numbers or to enumerate headers. See the file for more details.

The module is structured similar to alphanumeric/unicode-letters.js described above. It defined the transcode() function and the transcodeTables object. Additionally, it defines two more functions: numberExponent() and numberPunctuation().

Function numberExponent()

numberExponent(value, options) converts a number to a string with an exponent notation:

• value — number with an exponent represented as a string.
• options — an object with the following properties:
  • useSpecialMinus — if true, use a special math minus symbol instead of the dash.

Example

import {numberExponent} from 'console-toolkit/src/alphanumeric/unicode-numbers.js';

console.log(1e9);                                    // 1000000000
console.log(1e9.toExponential());                    // 1e+9
console.log(numberExponent((-1e9).toExponential())); // -1×10⁺⁹
console.log(numberExponent((-1e9).toExponential(),
  {useSpecialMinus: true}));                         // −1×10⁺⁹

Function numberPunctuation()

numberPunctuation(value, options) converts a number to a string with a punctuation notation:

• value — number with a punctuation represented as a string. It can be a result of formatNumber() or formatInteger() described above.
• options — an object with the following properties:
  • addBefore — string to add before a digit. Defaults to the empty string ('').
  • addAfter — string to add after a digit. Defaults to the space (' ').

Example

import {numberPunctuation} from 'console-toolkit/src/alphanumeric/unicode-numbers.js';

console.log('1,234.567'); // 🄂 23⒋ 567

Tables

The modules defines many transcoding tables. The following table was generated by scripts/numbers.js:

╭──────────────────────────────────┬─────────────────────╮
│ Name                             │ Result              │
├──────────────────────────────────┼─────────────────────┤
│ pattern                          │ 0 1 2 3 4 5 6 7 8 9 │
│ circled                          │ ⓪ ① ② ③ ④ ⑤ ⑥ ⑦ ⑧ ⑨ │
│ parens                           │ 0 ⑴ ⑵ ⑶ ⑷ ⑸ ⑹ ⑺ ⑻ ⑼ │
│ dots                             │ 🄀 ⒈ ⒉ ⒊ ⒋ ⒌ ⒍ ⒎ ⒏ ⒐ │
│ doubleCircled                    │ 0 ⓵ ⓶ ⓷ ⓸ ⓹ ⓺ ⓻ ⓼ ⓽ │
│ bold                             │ 𝟎 𝟏 𝟐 𝟑 𝟒 𝟓 𝟔 𝟕 𝟖 𝟗 │
│ doubleStruck                     │ 𝟘 𝟙 𝟚 𝟛 𝟜 𝟝 𝟞 𝟟 𝟠 𝟡 │
│ sansSerif                        │ 𝟢 𝟣 𝟤 𝟥 𝟦 𝟧 𝟨 𝟩 𝟪 𝟫 │
│ sansSerifBold                    │ 𝟬 𝟭 𝟮 𝟯 𝟰 𝟱 𝟲 𝟳 𝟴 𝟵 │
│ mono                             │ 𝟶 𝟷 𝟸 𝟹 𝟺 𝟻 𝟼 𝟽 𝟾 𝟿 │
│ commas                           │ 🄁 🄂 🄃 🄄 🄅 🄆 🄇 🄈 🄉 🄊 │
│ roman                            │ 0 Ⅰ Ⅱ Ⅲ Ⅳ Ⅴ Ⅵ Ⅶ Ⅷ Ⅸ │
│ romanLower                       │ 0 ⅰ ⅱ ⅲ ⅳ ⅴ ⅵ ⅶ ⅷ ⅸ │
│ dingbatsCircledSansSerif         │ 0 ➀ ➁ ➂ ➃ ➄ ➅ ➆ ➇ ➈ │
│ dingbatsNegativeCircled          │ ⓿ ❶ ❷ ❸ ❹ ❺ ❻ ❼ ❽ ❾ │
│ dingbatsNegativeCircledSansSerif │ 0 ➊ ➋ ➌ ➍ ➎ ➏ ➐ ➑ ➒ │
│ superscript                      │ ⁰ ¹ ² ³ ⁴ ⁵ ⁶ ⁷ ⁸ ⁹ │
│ subscript                        │ ₀ ₁ ₂ ₃ ₄ ₅ ₆ ₇ ₈ ₉ │
╰──────────────────────────────────┴─────────────────────╯

alphanumeric/unicode-cultural-numbers.js

The alphanumeric/unicode-cultural-numbers.js module provides tables of Unicode symbols for numbers of different cultures. See the file for more details.

It exports the transcodeTables object.

alphanumeric/utils.js

The alphanumeric/utils.js module provides utility functions used by the alphanumeric package to define transcode tables. See the file for more details.

Class SymbolRange

The SymbolRange class represents a range of symbols.

Name	Returns	Description
SymbolRange(fromSymbol, from = 0, to = 9, inputBase = '0')	SymbolRange	Creates a new SymbolRange object.
from	number	The starting value of the range.
to	number	The ending value of the range.
base	number	The offset from the starting value to the code point of fromSymbol.
inputBase	number	The starting code point of the range.
overlay	object or null	The other SymbolRange object or a transcoding table.
get(i)	string	Returns the symbol. If index a number, it is assumed to be an index in the range. If it is a character, it is assumed to be a code point.
transcode(text, options)	string	Returns the transcoded text.

If overlay is specified, it will be consulted first. overlay is used to override some symbols and create disjoint ranges. An overlay can have an overlay. An overlay can be a simple table: [a: '1', b: '2', c: '3'].

get() is used to get the symbol from the range. If index is a number, it is assumed to be an index in the range. Some ranges can have entries, which are not defined by a single symbol. For example, some decorated numbers can be in a range from 0 to 20. If we want to get a symbol for 12, we should use get(12). If it is a character, it is assumed to be a code point.

transcode(text, options) is used to transcode the text:

• text — the text to be transcoded.
• options — an object with the following properties:
  • missing — if specified it will be a character to be used in place of characters in the text that are not transcoded. Otherwise, a character is left as is.

It consults the transcoding table using get() for every character in the text.

Function transcode()

transcode(text, options) is similar to the transcode() function in the alphanumeric/unicode-letters.js module:

• text — the text to be transcoded.
• tables — an object defining the transcoding tables:
  • If it is a function it is consulted on every character and cna return a new value or a falsy value to indicate that the character cannot be transcoded.
  • If it is an object with the transcode() method, it is used to transcode the text.
  • If it is an array, it is assumed be an array of transcoding tables. They will be tried in order.
• options — an object with the following properties:
  • missing — if specified it will be a character to be used in place of characters in the text that are not transcoded. Otherwise, a character is left as is.