Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adam-rocska/units-and-measurement-typescript
A modular TypeScript library for working with units and measurements. Supports various formats (tuples, objects, strings) and provides tools for arithmetic, comparison, and unit conversion, all while being type-safe and tree-shakable.
https://github.com/adam-rocska/units-and-measurement-typescript
arithmetic-operations dimension javascript js math measurement measurement-units modular nodejs quantities scaling tree-shaking ts type-safety types typescript unit-aware unit-conversion unit-operation units
Last synced: 1 day ago
JSON representation
A modular TypeScript library for working with units and measurements. Supports various formats (tuples, objects, strings) and provides tools for arithmetic, comparison, and unit conversion, all while being type-safe and tree-shakable.
- Host: GitHub
- URL: https://github.com/adam-rocska/units-and-measurement-typescript
- Owner: adam-rocska
- License: mit
- Created: 2024-08-11T08:37:28.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-01-10T05:41:15.000Z (5 days ago)
- Last Synced: 2025-01-13T01:09:01.952Z (2 days ago)
- Topics: arithmetic-operations, dimension, javascript, js, math, measurement, measurement-units, modular, nodejs, quantities, scaling, tree-shaking, ts, type-safety, types, typescript, unit-aware, unit-conversion, unit-operation, units
- Language: TypeScript
- Homepage:
- Size: 1.04 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Units & Measurement
[](https://www.npmjs.com/package/@adam-rocska/units-and-measurement)
[](https://github.com/adam-rocska/units-and-measurement-typescript/blob/master/LICENSE)
| Aspect | Badge |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Minified | [](https://bundlephobia.com/package/@adam-rocska/units-and-measurement) |
| Minified + gzip | [](https://bundlephobia.com/package/@adam-rocska/units-and-measurement) |
| Dependency Count | [](https://bundlephobia.com/package/@adam-rocska/units-and-measurement) |
| Tree-shaking Support | [](https://bundlephobia.com/package/@adam-rocska/units-and-measurement) |
A library for handling units and measurements in TypeScript.
The library is broken down into several modules, each of
which can be used independently.
## `@adam-rocska/units-and-measurement`
The main module providing all the units necessary or
convenient for working with units and measurements safely
without boilerplate.
Measurements may be expressed as:
- **tuples:** Simplest form: `[15, "px"]`.
- **objects:** Simplest form: `{ value: 15, unit: "px" }`.
- **strings:** Simplest form: `"15px"`. _Yes. THAT simple._
- **dimension:** Simplest form when using a known provided
dimension: `inches(11)`.
where dimensions are a special monad of an object representation.
Utilities provided for measurements:
- **type predicates:** They help identify `any` value as a
general or specific type of measurement.
- **factory utilities:** called simply `measurement`,
specialized by the respective specifier namespace or used
in its general form. Not necessary but useful in many cases
to reduce boilerplates.
- **value and unit readers:** They help extract the value or
unit from a measurement, let it be a general or specific
type of measurement.
- **toFixed and toPrecision:** Provide alternatives for the
`Number` type's `toFixed` and `toPrecision` methods on both
specific and generic measurements.
## `@adam-rocska/units-and-measurement/operations`
A module providing convenient utilities to perform operations
on measurements.
It includes the following:
- arithmetic operations: addition, subtraction, multiplication,
division, exponentiation, root and logarithm.
- comparison operations
- a utility for general purpose arithmetic operations
- a utility for general purpose logical operations
## `@adam-rocska/units-and-measurement/${DIMENSION}`
Every dimension submodule provides the following:
- Unit symbol type predicates
- List of known unit symbols
- Unit symbols as types.
- The dimension object, as anyone would provide one using
`@adam-rocska/units-and-measurement`
- Aliases for the dimension factories.
## Example
```typescript
const paperWidth = inches(5.5);
const paperHeight = inches(11);
// toFixed, to avoid floating point errors
if (areEqual(toFixed(paperWidth.cm, 2), centimeters(13.97))) {
console.log("The paper width is 13.97 cm.");
}
```