@zerodep/to.number NPM

@zerodep/to.number

language types

last commit vulnerabilities

A configurable utility to convert a value (string, boolean, date, or BigInt) to a number.

tl;dr

A short explanation / quick reference:

import { toNumber } from '@zerodep/to.number';

// uses the default configuration options
toNumber('3.1415'); // 3.1415
toNumber('3e8'); // 300000000
toNumber(Symbol()); // throws ZeroDepErrorTo

Install

This utility is available from multiple @zerodep packages, enabling developers to select the most appropriately sized package (for both kb and capability) for different use cases. We believe one size does not fit all or most. See @zerodep/app, @zerodep/utils and @zerodep/is.

For Server & Build Tooling

For Node, or when compiling via babel, rollup, swc, tsc, webpack, etc... these are the instructions for you.

// all @zerodep features, capabilities and utilities
npm install @zerodep/app

// entire set of @zerodep utilities
npm install @zerodep/utils

// all @zerodep "to" utilities
npm install @zerodep/to

// only the to.number package
npm install @zerodep/to.string

Of course, you may use yarn, pnpm, or the package manager of your choice. Only npm examples are shown for brevity.

Browser Direct

If you are using the script directly in a browser via a <script> tag or importing it into your own scripts, these are the instructions for you. We support both ESM and UMD formats.

<!-- for ES Modules (ESM) -->
<script type="module">
  import { toNumber } from 'https://cdn.jsdelivr.net/npm/@zerodep/to.number/esm.js';
  // ...your code here
</script>

<!--  OR  -->

<!--  for Universal Modules (UMD) - all @zerodep functions are in the global "zd" namespace -->
<script src="https://cdn.jsdelivr.net/npm/@zerodep/to.number/umd.js"></script>
<script>
  // example of "zd" prefix
  const result = zd.toNumber(8675309n);
</script>

This package may be found on both jsDelivr and unpkg in UMD, ESM and CJS formats.

How to Use

This package exports the following:

Functions
- toNumber - a converter that uses the default configuration options (suitable for most)
- toNumberHof - a higher-order function that may be configured and returns a converter function based on the configurations
Interface
- ToNumberOptions - a typescript interface of the options that may be set in the HOF
Error types
- ZeroDepErrorTo - the subclass of error thrown by all @zerodep/to.* packages
- ZeroDepError - the error class all ZeroDep packages extend from, is an instance of the base Error object

Signature

Typescript declarations:

// using default configuration options
declare const toNumber: (value: any) => number;

Examples

All examples assume ESM or CJS packages. If using a UMD package remember to prefix with the zd namespace, e.g. zd.toNumber(...).

Using Default Configuration Options

// import from the most appropriate @zerodep package for your needs / specific use case (see the Install section above)
import { toNumber } from '@zerodep/to.number';

// strings
toNumber(''); // 0
toNumber('42'); // 42
toNumber('a string'); // throws ZeroDepErrorTo

// integers
toNumber(42); // 42
toNumber(3e8); // 300000000

// floats
toNumber(-273.15); // -273.15
toNumber(Math.PI); // 3.141593

// number-ish
toNumber(Number.POSITIVE_INFINITY); // throws ZeroDepErrorTo
toNumber(NaN); // throws ZeroDepErrorTo

// bigints
toNumber(8675309n); // 8675309

// object literals
toNumber({}); // throws ZeroDepErrorTo
toNumber({ a: 'one', b: 'two' }); // throws ZeroDepErrorTo

// arrays
toNumber([]); // throws ZeroDepErrorTo
toNumber([1, 2, 3]); // throws ZeroDepErrorTo
toNumber(['a', 'b', 'c']); // throws ZeroDepErrorTo

// booleans
toNumber(true); // 1
toNumber(false); // 0

// other
toNumber(Date('2022-04-22T10:30:00.000Z')); // 1650623400000
toNumber(/^$\d{7}/g); // throws ZeroDepErrorTo
toNumber(new Set()); // throws ZeroDepErrorTo
toNumber(new Set([1, 2, 3])); // throws ZeroDepErrorTo
toNumber(new Map()); // // throws ZeroDepErrorTo
toNumber(new Map([['a', 1]])); // // throws ZeroDepErrorTo
toNumber(new Symbol()); // throws ZeroDepErrorTo
toNumber(new Error()); // throws ZeroDepErrorTo
toNumber(() => {}); // throws ZeroDepErrorTo

// nothing
toNumber(null); // // throws ZeroDepErrorTo
toNumber(undefined); // // throws ZeroDepErrorTo

Related Packages

The following @zerodep packages may be helpful or more appropriate for your specific case:

@zerodep/is.number - checks if a value is a number

Advantages of @zerodep Packages

We help make source code more readable, more secure, faster to craft, less likely to have hidden defects, and easier to maintain.

Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
Fully typed - typescript definitions are provided for every package for a better developer experience
Semantically named - package and method names are easy to grok, remember, use, and read
Documented - actually useful documentation with examples and helpful tips
Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
100% Tested - all methods and packages are fully unit tested
ESM & CJS - has both ecmascript modules and common javascript exports, both are fully tree-shakable
CDN Available - available on fast content delivery networks in UMD, CJS and ESM formats
FP Inspired - gently opinionated to encourage functional programming style for cleaner and more maintainable software
Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
MIT Licensed - permissively licensed for maximum usability

Support

All @zerodep packages are built for the ES2020 specification. Should you need to support older environments you will need to add appropriate polyfills. All packages are tested on the following platforms/browsers:

Browsers

Chrome - last 2 major versions
Firefox - last 2 major versions
Safari - last 2 major versions
Edge - last 2 major versions
Android - last 2 major versions
iOS - last 2 major versions

Node

v16.x - Gallium LTS
v14.x - Fermium LTS

It is likely the package will work on other technologies and version, however development and testing effort is only spent on the above.

Semver

All @zerodep packages, including this one, adhere to Semantic Versioning practices:

major versions: correlates with breaking changes to one or more method signatures
minor versions: includes addition of new functionality or backwards-compatible software improvements
patch versions: are reserved for copy changes, documentation enhancements and bug fixes

The above said, a security best practice is to pin your software packages to specific versions and only upgrade to more recent releases after careful inspection of any CHANGELOG, release notes and all software changes.