UNPKG

@augment-vir/common

Version:

A collection of augments, helpers types, functions, and classes for any JavaScript environment.

github.com/electrovir/augment-vir

electrovir/augment-vir

30 lines (29 loc) • 1.18 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/** * Converts the input into a number and returns `NaN` if the conversion fails. This handles more * edge cases than just plain `Number(input)`. * * @category Number * @category Package : @augment-vir/common * @returns The converted number or `NaN`. * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common) */ export declare function toNumber(input: unknown): number; /** * Converts the input into a number and throws an error if the conversion fails. * * @category Number * @category Package : @augment-vir/common * @returns The converted number * @throws `TypeError` if the conversion resulted in `NaN` * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common) */ export declare function toEnsuredNumber(input: unknown): number; /** * Converts the input into a number and returns `undefined` if the conversion fails. * * @category Number * @category Package : @augment-vir/common * @returns The converted number or `undefined`. * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common) */ export declare function toMaybeNumber(input: unknown): number | undefined;