Class TimeUnit

Hierarchy (View Summary)

Unit
- TimeUnit

Index

Constructors

Properties

HOUR MICROSECOND MILLISECOND MINUTE NANOSECOND SECOND UNIT_BASES UNITS UNKNOWN

Accessors

aliases baseName definitions name prefixes prefixType

Methods

convert createBaseDefinition createDefinition findByName specifier convert findByName fromJSON registerUnit

Constructors

constructor

new TimeUnit(name?: string, options?: UnitOptions): TimeUnit
Create a new unit
Parameters
- Optionalname: string
  Unit name
- Optionaloptions: UnitOptions
  Unit options
Returns TimeUnit
Inherited from Unit.constructor
- Defined in src/utils/unit/Unit.ts:50

Properties

`Static` `Readonly`HOUR

HOUR: TimeUnit = ...

`Static` `Readonly`MICROSECOND

MICROSECOND: TimeUnit = ...

`Static` `Readonly`MILLISECOND

MILLISECOND: TimeUnit = ...

`Static` `Readonly`MINUTE

MINUTE: TimeUnit = ...

`Static` `Readonly`NANOSECOND

NANOSECOND: TimeUnit = ...

`Static` `Readonly`SECOND

SECOND: TimeUnit = ...

`Protected` `Static` `Readonly`UNIT_BASES

UNIT_BASES: Map<string, string> = ...

`Protected` `Static` `Readonly`UNITS

UNITS: Map<string, Unit> = ...

`Static` `Readonly`UNKNOWN

UNKNOWN: Unit = ...

Accessors

aliases

get aliases(): string[]
Unit aliases

Returns string[]
Alias names as array
Inherited from Unit.aliases
- Defined in src/utils/unit/Unit.ts:156

baseName

get baseName(): string
Returns string
Inherited from Unit.baseName
- Defined in src/utils/unit/Unit.ts:160

definitions

get definitions(): UnitDefinition[]
Returns UnitDefinition[]
Inherited from Unit.definitions
- Defined in src/utils/unit/Unit.ts:168

name

get name(): string
Unit name

Returns string
Name
Inherited from Unit.name
- Defined in src/utils/unit/Unit.ts:137
set name(name: string): void
Parameters
- name: string
Returns void
Inherited from Unit.name
- Defined in src/utils/unit/Unit.ts:141

`Protected`prefixes

get prefixes(): UnitPrefix[]
Returns UnitPrefix[]
Inherited from Unit.prefixes
- Defined in src/utils/unit/Unit.ts:172

prefixType

get prefixType(): UnitPrefixType
Returns UnitPrefixType
Inherited from Unit.prefixType
- Defined in src/utils/unit/Unit.ts:164

Methods

convert

convert<T extends UnitValueType>(value: T, target: string | Unit): T
Convert a value in the current unit to a target unit
Type Parameters
- T extends UnitValueType
Parameters
- value: T
  Value to convert
- target: string | Unit
  Target unit
Returns T
Converted unit
Inherited from Unit.convert
- Defined in src/utils/unit/Unit.ts:346

createBaseDefinition

createBaseDefinition(): UnitFunctionDefinition<any, any>
Get or create a definition from this unit to the base

Returns UnitFunctionDefinition<any, any>
Definition to base
Inherited from Unit.createBaseDefinition
- Defined in src/utils/unit/Unit.ts:185

createDefinition

createDefinition(targetUnit: Unit): UnitFunctionDefinition<any, any>
Parameters
- targetUnit: Unit
Returns UnitFunctionDefinition<any, any>
Inherited from Unit.createDefinition
- Defined in src/utils/unit/Unit.ts:212

`Protected`findByName

findByName(name: string): Unit
Find unit specifier by name or alias
Parameters
- name: string
  Unit name
Returns Unit
Unit if found
Inherited from Unit.findByName
- Defined in src/utils/unit/Unit.ts:294

specifier

specifier(prefix: UnitPrefix): this
Get the unit specifier
Parameters
- prefix: UnitPrefix
  Unit prefix
Returns this
Unit with specifier
Inherited from Unit.specifier
- Defined in src/utils/unit/Unit.ts:259

`Static`convert

convert<T extends UnitValueType>(
    value: T,
    from: string | Unit,
    to: string | Unit,
): T
Convert a value from a specific unit to a target unit
Type Parameters
- T extends UnitValueType
Parameters
- value: T
  Value to convert
- from: string | Unit
  Source unit
- to: string | Unit
  Target unit
Returns T
Converted unit
Inherited from Unit.convert
- Defined in src/utils/unit/Unit.ts:380

`Static`findByName

findByName(name: string, baseName?: string): Unit
Find a unit by its name
Parameters
- name: string
  Unit name
- OptionalbaseName: string
  Optional base name to specific result
Returns Unit
Unit if found
Inherited from Unit.findByName
- Defined in src/utils/unit/Unit.ts:319

`Static`fromJSON

fromJSON<T extends Unit>(json: any): T
Get a unit from JSON
Type Parameters
- T extends Unit
Parameters
- json: any
  JSON object
Returns T
Unit if found
Inherited from Unit.fromJSON
- Defined in src/utils/unit/Unit.ts:75

`Static`registerUnit

registerUnit(unit: Unit, override?: boolean): Unit
Register a new unit
Parameters
- unit: Unit
  Unit to register
- override: boolean = false
  Override an existing unit with the same name
Returns Unit
Registered unit
Inherited from Unit.registerUnit
- Defined in src/utils/unit/Unit.ts:391