Quantity - Documentation

Members

dimension :string

Source:

quantity.js, line 103

Dimension of this Quantity, e.g. [L] for metres or [L]² for cubic-metres

Type:

string

unit :string|null

Source:

quantity.js, line 111

Unit of this Quantity, e.g. Metre, or null if not available

Type:

string | null

symbol :string|null

Source:

quantity.js, line 120

Unit symbol of this Quantity, e.g. m, or null if not available

Type:

string | null

float :number

Source:

quantity.js, line 129

Float (decimal number) value of this Quantity

Type:

number

int :number

Source:

quantity.js, line 137

Integer (non-decimal number) value of this Quantity

Type:

number

Methods

add(value) → {Quantity}

Source:

quantity.js, line 147

Add the given value to this Quantity.

Parameters:

Name	Type	Description
`value`	string \| Quantity	`string` consisting of amount and unit or a Quantity

Returns:

result as new Quantity

Type: Quantity

divide(value) → {Quantity}

Source:

quantity.js, line 162

Divide this Quantity by the given value.

Example

Quantity('20 W').divide(4); // is 5 W
Quantity('20 W').divide('4 W') // is 5

Parameters:

Name	Type	Description
`value`	number \| string \| Quantity	usually a number; may also be a `string` consisting of amount and unit or a Quantity, but be careful: 1 W / 5 W = 0.2 which might not be what you want

Returns:

result as new Quantity

Type: Quantity

multiply(value) → {Quantity}

Source:

quantity.js, line 177

Multiply this Quantity by the given value.

Example

Quantity('20 W').multiply(4); // is 80 W
Quantity('20 W').multiply('4 W') // is 80 W^2

Parameters:

Name	Type	Description
`value`	number \| string \| Quantity	usually a number; may also be a `string` consisting of amount and unit or a Quantity, but be careful: 1 W * 5 W = 5 W^2 which might not be what you want

Returns:

result as new Quantity

Type: Quantity

subtract(value) → {Quantity}

Source:

quantity.js, line 188

Subtract the given value from this Quantity.

Parameters:

Name	Type	Description
`value`	string \| Quantity	`string` consisting of amount and unit or a Quantity

Returns:

result as new Quantity

Type: Quantity

toUnit(unit) → {Quantity|null}

Source:

quantity.js, line 199

Convert this Quantity to the given unit.

Parameters:

Name	Type	Description
`unit`	string

Returns:

a new Quantity with the given unit or null if conversion to this unit is not possible

Type: Quantity | null

equal(value) → {boolean}

Source:

quantity.js, line 215

Checks whether this Quantity is equal to the passed in value.

Parameters:

Name	Type	Description
`value`	string \| Quantity

Returns:

Type: boolean

greaterThan(value) → {boolean}

Source:

quantity.js, line 226

Checks whether this Quantity is larger than the passed in value.

Parameters:

Name	Type	Description
`value`	string \| Quantity

Returns:

Type: boolean

greaterThanOrEqual(value) → {boolean}

Source:

quantity.js, line 237

Checks whether this Quantity is larger than or equal to the passed in value.

Parameters:

Name	Type	Description
`value`	string \| Quantity

Returns:

Type: boolean

lessThan(value) → {boolean}

Source:

quantity.js, line 248

Checks whether this Quantity is smaller than the passed in value.

Parameters:

Name	Type	Description
`value`	string \| Quantity

Returns:

Type: boolean

lessThanOrEqual(value) → {boolean}

Source:

quantity.js, line 259

Checks whether this Quantity is smaller than or equal to the passed in value.

Parameters:

Name	Type	Description
`value`	string \| Quantity

Returns:

Type: boolean