Class UnitParser

This class helps to extract a value and a unit from a string, by the given format.

Index

Constructors

Properties

caseInsensitive format maxDecimalPlaces units

Methods

Constructors

constructor

new UnitParser(opts: IUnitParserOptions): UnitParser
Parameters
- opts: IUnitParserOptions
Returns UnitParser
- Defined in Classes/UnitParser.ts:124

Properties

`Readonly`caseInsensitive

caseInsensitive: boolean

Whether to ignore case when matching the unit.

`Readonly`format

format: string

The format of the string to parse.

`Readonly`maxDecimalPlaces

maxDecimalPlaces: number

The maximum number of decimal places to allow.

`Readonly`units

units: readonly Readonly<IUnitInfo>[]

The names of the units to parse.

Methods

parse

parse(input: string): null | IUnitParserResult
Extract the value and unit from the given string.
Parameters
- input: string
  The string to parse.
Returns null | IUnitParserResult
An object containing the value and unit, or null if the string does not match the format.
- Defined in Classes/UnitParser.ts:215