@technobuddha > library > Math > Verbalization

Type Alias: OrdinalOptions

type OrdinalOptions = {
  and?: Numbering["and"];
  denominators?: Numbering["denominators"];
  hyphen?: Numbering["hyphen"];
  ordinal?: Numbering["ordinal"];
  output?:   | "suffix"
     | "numeric"
     | "alphabetic"
     | "hybrid"
     | Numbering["output"];
  precision?: Numbering["precision"];
  shift?: Numbering["shift"];
  tolerance?: Numbering["tolerance"];
};

Defined in: ordinal.ts:10

Options for formatting ordinal numbers.

Properties

Property	Type	Default value	Description	Defined in
and?	Numbering["and"]	(empty string)	Text to use for "and" in compound numbers (e.g., "one hundred and one").	src/ordinal.ts:21
denominators?	Numbering["denominators"]	'common'	Type of denominators to use when expressing fractions.	src/ordinal.ts:39
hyphen?	Numbering["hyphen"]	' ' (space)	Text to use for hyphens in compound numbers (e.g., "twenty-one").	src/ordinal.ts:27
ordinal?	Numbering["ordinal"]	false	Whether to output ordinal numbers (e.g., "first", "second") instead of cardinal numbers.	src/ordinal.ts:51
output?	| "suffix" | "numeric" | "alphabetic" | "hybrid" | Numbering["output"]	'alphabetic'	Output format for the number representation.	src/ordinal.ts:15
precision?	Numbering["precision"]	9	Precision for decimal/fraction conversion.	src/ordinal.ts:45
shift?	Numbering["shift"]	undefined	Whether to shift the fractional part of the number.	src/ordinal.ts:56
tolerance?	Numbering["tolerance"]	0.01	Tolerance for floating-point comparison when converting decimals to fractions.	src/ordinal.ts:33