Maker.js, a Microsoft Garage project, is a JavaScript library for creating and sharing modular line drawings for CNC and laser cutters.

View project on GitHub

Star

Api - units Module

Index

Variables

base
table

Functions

Variables

Private base

base: string

The base type is arbitrary. Other conversions are then based off of this.

Private table

table: object

Table of conversions. Lazy load upon first conversion.

Type declaration

[unitType: string]: object
- [unitType: string]: number

Functions

Private addBaseConversion

addBaseConversion(destUnitType: string, value: number): void

- Defined in core/units.ts:47
Add a conversion of the base unit.

Parameters
- destUnitType: string
- value: number
Returns void

Private addConversion

addConversion(srcUnitType: string, destUnitType: string, value: number): void

- Defined in core/units.ts:30
Add a conversion, and its inversion.

Parameters
- srcUnitType: string
- destUnitType: string
- value: number
Returns void

conversionScale

conversionScale(srcUnitType: string, destUnitType: string): number

- Defined in core/units.ts:58
Get a conversion ratio between a source unit and a destination unit.

Parameters
- srcUnitType: string
  
  unitType converting from.
- destUnitType: string
  
  unitType converting to.
Returns number

Numeric ratio of the conversion.

Private init

init(): void

- Defined in core/units.ts:13
Initialize all known conversions here.

Returns void

Generated using TypeDoc