Package Exports

quantity-fns

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (quantity-fns) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Quantity Functions

This library aims to provide a set of functions and utilities for conversion between units of mass, volume, and energy.

At this early stage it is still missing many features and units (See Notice).

Please feel free to fork and raise a pull request to add functionailty you deem widely useful within this domain (See Contributions).

Getting Started
Notice
License
Contributions
- Developer's Certificate of Origin 1.1

Getting Started

The below examples are given in TypeScript, but should be easily adapted to JavaScript. TypeScript definitions are bundled with the package.

Converting from kilos into grams

import { convert as convertMass } from "quantity-fns/mass"
convertMass({
    unit: 'kg',
    quantity: 10,
    type: 'mass'
}, 'g') // === {unit: 'g', quantity: 10000}

Converting from Millilitres to Litres

import { convert as convertVolume } from "quantity-fns/volume"
convertVolume({
    unit: 'ml',
    quantity: 10,
    type: 'volume'
}, 'L') // === {unit: 'L', quantity: 10000}

Calculating the mass of 1L of water

import { volumeToMass } from "quantity-fns/volume"
import { DensityOf } from "quantity-fns/density";
volumeToMass({
    unit: 'ml',
    quantity: 100,
    type: 'volume'
}, DensityOf.Water /*, "g"*/) // === {quantity: 100, unit: "g", type: "mass"}

Convert from Joules to Kilocalories

import { convert as convertEnergy } from "quantity-fns/energy"
convertEnergy({
    unit: 'J',
    quantity: 100,
    type: 'energy'
}, 'kcal') // === { quantity: 0.02390057361376673, unit: 'kcal', type: 'energy' }

Notice

At this early stage this library cannot be garunteed to be as accurate as needed for many use cases, there may exist flaws and issues inherent to any software project which are not tested against. For this reason libraries such as this one may not be suitable for mission critical applications such as medical devices.

If you do decide to use this library in such applications please be thorough in your testing.

However in the interest of developing this further you may wish to open a pull request against this library to test, prove and improve the accuracy of the results. This kind of contribution is greatly appreciated (See Contributions).

License

This Library and its source code is licensed under the ISC license.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Source: http://opensource.org/licenses/ISC

Contributions

Contributions can be made by submitting a pull request against the github project

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

a. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

b. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

c. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

d. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

quantity-fns