From 3be6563489f7876aed2171f8bbcdb197652039b1 Mon Sep 17 00:00:00 2001 From: Jake Boone Date: Fri, 1 Dec 2023 11:53:45 -0700 Subject: [PATCH] Add GA tracking --- docs/functions/formatQuantity-1.html | 5 ++++- docs/index.html | 5 ++++- docs/interfaces/FormatQuantity.html | 5 ++++- docs/interfaces/FormatQuantityOptions.html | 13 ++++++++----- docs/modules.html | 5 ++++- docs/types/SimpleFraction.html | 5 ++++- docs/types/Sixteenth.html | 5 ++++- docs/types/VulgarFraction.html | 5 ++++- docs/variables/defaultOptions.html | 5 ++++- docs/variables/defaultTolerance.html | 5 ++++- docs/variables/fractionDecimalMatches.html | 5 ++++- docs/variables/vulgarToAsciiMap.html | 5 ++++- typedoc.json | 3 ++- 13 files changed, 54 insertions(+), 17 deletions(-) diff --git a/docs/functions/formatQuantity-1.html b/docs/functions/formatQuantity-1.html index eb41c6f..7fc29ca 100644 --- a/docs/functions/formatQuantity-1.html +++ b/docs/functions/formatQuantity-1.html @@ -6,4 +6,7 @@ "1 1/2" instead of "1.5". To use vulgar fraction characters like "½", pass true as the second argument. For other options see FormatQuantityOptions.

-

Parameters

Returns null | string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns null | string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 6cc9751..9beda19 100644 --- a/docs/index.html +++ b/docs/index.html @@ -90,4 +90,7 @@

When this option is true, all other options are ignored.

formatQuantity(1214, { romanNumerals: true }); // "MCCXIV"
formatQuantity(12.14, { romanNumerals: true, vulgarFractions: true }); // "XII"
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/FormatQuantity.html b/docs/interfaces/FormatQuantity.html index 248e33e..028f01b 100644 --- a/docs/interfaces/FormatQuantity.html +++ b/docs/interfaces/FormatQuantity.html @@ -2,4 +2,7 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$$","right":"$$","display":true},{"left":"$","right":"$","display":false}]}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Interface FormatQuantity

Function signature of formatQuantity.

-
interface FormatQuantity ((qty, options?) => null | string)
  • FormatQuantity(qty, options?): null | string

  • Parameters

    Returns null | string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +
interface FormatQuantity ((qty, options?) => null | string)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/FormatQuantityOptions.html b/docs/interfaces/FormatQuantityOptions.html index 5022f12..b293dd1 100644 --- a/docs/interfaces/FormatQuantityOptions.html +++ b/docs/interfaces/FormatQuantityOptions.html @@ -1,23 +1,26 @@ FormatQuantityOptions | format-quantity - v2.1.0

Interface FormatQuantityOptions

interface FormatQuantityOptions {
    fractionSlash?: boolean;
    romanNumerals?: boolean;
    tolerance?: number;
    vulgarFractions?: boolean;
}

Properties

fractionSlash? +

Interface FormatQuantityOptions

interface FormatQuantityOptions {
    fractionSlash?: boolean;
    romanNumerals?: boolean;
    tolerance?: number;
    vulgarFractions?: boolean;
}

Properties

fractionSlash? romanNumerals? tolerance? vulgarFractions?

Properties

Optional fractionSlash

fractionSlash?: boolean

Output the fraction slash character (⁄) instead of the "solidus" slash (/) for fractions. Results appear like "1⁄2" instead of "1/2". Overridden by the vulgarFractions option.

-

Optional romanNumerals

romanNumerals?: boolean

Output in Roman numerals. Provided value must be between 1 and 3999, inclusive. +

Optional romanNumerals

romanNumerals?: boolean

Output in Roman numerals. Provided value must be between 1 and 3999, inclusive. Decimal values will be ignored (Math.floor is used to remove them). Overrides all other options.

-

Optional tolerance

tolerance?: number

Amount by which a number can deviate from the calculated quotient to be +

Optional tolerance

tolerance?: number

Amount by which a number can deviate from the calculated quotient to be considered a match. For example, 0.66 is close enough to 2 ÷ 3 (which is 0.66666... repeating) to be considered equivalent so the function will return "2/3". The smaller this number, the higher the likelihood that the function will return a decimal instead of a fraction or mixed number.

Default

0.0075
-

Optional vulgarFractions

vulgarFractions?: boolean

Output vulgar fractions, like "½" instead of "1/2", when appropriate. +

Optional vulgarFractions

vulgarFractions?: boolean

Output vulgar fractions, like "½" instead of "1/2", when appropriate. Overrides the fractionSlash option.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 8345dc1..79b43d6 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -12,4 +12,7 @@ fractionDecimalMatches vulgarToAsciiMap

Functions

formatQuantity -

References

default

Renames and re-exports formatQuantity

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

References

default

Renames and re-exports formatQuantity

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/SimpleFraction.html b/docs/types/SimpleFraction.html index 12ce054..0f5666c 100644 --- a/docs/types/SimpleFraction.html +++ b/docs/types/SimpleFraction.html @@ -4,4 +4,7 @@

Type alias SimpleFraction

SimpleFraction: `${NonZeroDigit}/${NonZeroDigit}` | `${NonZeroDigit}/${NonZeroDigit}${Digit}` | `${NonZeroDigit}${Digit}/${NonZeroDigit}${Digit}`

Fraction string with either one or two numeric characters in both the numerator and denominator (but not two characters in the numerator while the denominator only has one).

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/Sixteenth.html b/docs/types/Sixteenth.html index f39220c..426aafd 100644 --- a/docs/types/Sixteenth.html +++ b/docs/types/Sixteenth.html @@ -2,4 +2,7 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$$","right":"$$","display":true},{"left":"$","right":"$","display":false}]}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Type alias Sixteenth

Sixteenth: `${"1" | "3" | "5" | "7" | "9" | "11" | "13" | "15"}/16`

Odd numerator sixteenth fraction strings.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/VulgarFraction.html b/docs/types/VulgarFraction.html index 11a6aae..fa2cdc9 100644 --- a/docs/types/VulgarFraction.html +++ b/docs/types/VulgarFraction.html @@ -2,4 +2,7 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$$","right":"$$","display":true},{"left":"$","right":"$","display":false}]}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Type alias VulgarFraction

VulgarFraction: "¼" | "½" | "¾" | "⅐" | "⅑" | "⅒" | "⅓" | "⅔" | "⅕" | "⅖" | "⅗" | "⅘" | "⅙" | "⅚" | "⅛" | "⅜" | "⅝" | "⅞"

Unicode vulgar fraction code points.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/defaultOptions.html b/docs/variables/defaultOptions.html index aba0551..a291a00 100644 --- a/docs/variables/defaultOptions.html +++ b/docs/variables/defaultOptions.html @@ -2,4 +2,7 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$$","right":"$$","display":true},{"left":"$","right":"$","display":false}]}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Variable defaultOptionsConst

defaultOptions: {
    fractionSlash: false;
    romanNumerals: false;
    tolerance: 0.0075;
    vulgarFractions: false;
} = ...

Default options for formatQuantity.

-

Type declaration

  • Readonly fractionSlash: false
  • Readonly romanNumerals: false
  • Readonly tolerance: 0.0075
  • Readonly vulgarFractions: false

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/defaultTolerance.html b/docs/variables/defaultTolerance.html index 50576c8..4fb5266 100644 --- a/docs/variables/defaultTolerance.html +++ b/docs/variables/defaultTolerance.html @@ -3,4 +3,7 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Variable defaultToleranceConst

defaultTolerance: 0.0075 = ...

Default tolerance used by formatQuantity when determining if a number is close enough to a fraction value to be considered equivalent.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/fractionDecimalMatches.html b/docs/variables/fractionDecimalMatches.html index 780715b..15d9e17 100644 --- a/docs/variables/fractionDecimalMatches.html +++ b/docs/variables/fractionDecimalMatches.html @@ -3,4 +3,7 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Variable fractionDecimalMatchesConst

fractionDecimalMatches: ([number, "⅓"] | [number, "⅔"] | [number, "⅕"] | [number, "⅖"] | [number, "⅗"] | [number, "⅘"] | [number, "⅙"] | [number, "⅚"] | [number, "⅐"] | [number, "⅑"] | [number, "⅒"] | [number, "⅛"] | [number, "¼"] | [number, "⅜"] | [number, "½"] | [number, "⅝"] | [number, "¾"] | [number, "⅞"] | [number, "1/16"] | [number, "3/16"] | [number, "5/16"] | [number, "7/16"] | [number, "9/16"] | [number, "11/16"] | [number, "13/16"] | [number, "15/16"])[] = ...

Map of "close enough" decimal values to the VulgarFraction or Sixteenth fraction string matches.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/vulgarToAsciiMap.html b/docs/variables/vulgarToAsciiMap.html index 18f64cf..b48fe7c 100644 --- a/docs/variables/vulgarToAsciiMap.html +++ b/docs/variables/vulgarToAsciiMap.html @@ -2,4 +2,7 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$$","right":"$$","display":true},{"left":"$","right":"$","display":false}]}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Variable vulgarToAsciiMapConst

vulgarToAsciiMap: {
    ¼: "1/4";
    ½: "1/2";
    ¾: "3/4";
    ⅐: "1/7";
    ⅑: "1/9";
    ⅒: "1/10";
    ⅓: "1/3";
    ⅔: "2/3";
    ⅕: "1/5";
    ⅖: "2/5";
    ⅗: "3/5";
    ⅘: "4/5";
    ⅙: "1/6";
    ⅚: "5/6";
    ⅛: "1/8";
    ⅜: "3/8";
    ⅝: "5/8";
    ⅞: "7/8";
} = ...

Map of vulgar fractions to their traditional ASCII equivalents.

-

Type declaration

  • Readonly ¼: "1/4"
  • Readonly ½: "1/2"
  • Readonly ¾: "3/4"
  • Readonly ⅐: "1/7"
  • Readonly ⅑: "1/9"
  • Readonly ⅒: "1/10"
  • Readonly ⅓: "1/3"
  • Readonly ⅔: "2/3"
  • Readonly ⅕: "1/5"
  • Readonly ⅖: "2/5"
  • Readonly ⅗: "3/5"
  • Readonly ⅘: "4/5"
  • Readonly ⅙: "1/6"
  • Readonly ⅚: "5/6"
  • Readonly ⅛: "1/8"
  • Readonly ⅜: "3/8"
  • Readonly ⅝: "5/8"
  • Readonly ⅞: "7/8"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/typedoc.json b/typedoc.json index 59d4066..7a08964 100644 --- a/typedoc.json +++ b/typedoc.json @@ -16,5 +16,6 @@ { "left": "$", "right": "$", "display": false } ] } - } + }, + "gaID": "G-8YZWBQLQD8" }