Class Unit

Represents a measurable unit.

Hierarchy

Compound<Unit>
- Unit

Index

Constructors

Properties

Methods

is over pow prefix times to toString

Constructors

constructor

new Unit(
    LaTeXsymbol?: string | Map<Unit, number>,
    base?: Dimension | Unit,
    scale?: number,
    allowPrefix?: boolean,
): Unit
Define a new named unit.
Parameters
- OptionalLaTeXsymbol: string | Map<Unit, number>
  The LaTeX code for this unit
- Optionalbase: Dimension | Unit
  The base dimension or makeup of unit(s)
- scale: number = 1
  The scale factor of this unit relative to the units in base
- allowPrefix: boolean = true
  Whether or not this unit can have a prefix applied
Returns Unit
Overrides Compound<Unit>.constructor

Properties

`Readonly`dimensions

dimensions: Dimension = ...

The base dimensions of this unit.

Methods

is

is(other: Unit): boolean
Determine if this compound is made up of the same factors as another.
Parameters
- other: Unit
  Another compound to compare to
Returns boolean
Whether or not this compound matches another

Inherited from Compound.is

over

over(dividend: Unit): Unit
Divide this compound by another.
Parameters
- dividend: Unit
  The compound to divide by
Returns Unit
The quotient of two compounds

Inherited from Compound.over

pow

pow(exponent: number): Unit
Raise this compound to an exponent.
Parameters
- exponent: number
  The exponent to raise this compound by
Returns Unit
The power of this compound and exponent

Inherited from Compound.pow

prefix

prefix(prefix: Prefix): Unit
Scale this unit by applying a prefix.
Parameters
- prefix: Prefix
  The prefix to apply
Returns Unit
A properly scaled unit

times

times(factor: Unit): Unit
Multiply this compound by another.
Parameters
- factor: Unit
  Another term or compound of similar terms
Returns Unit
The product of two compounds

Inherited from Compound.times

to

to(other: Unit): number
Calculate the conversion factor between this unit and another unit.
Parameters
- other: Unit
  Another unit to convert to
Returns number
The conversion factor between this unit and another

toString

toString(): string
Pretty-print this compound as a LaTeX formula.

Returns string
The compound written as a LaTeX formula

Inherited from Compound.toString