validateNumber
Description
It resolves if the parameter passed is of a number type, else, it will reject.
| Parameter List | Returns | Rejection Errors |
|---|---|---|
| Promise<number || Array> | |
| Related Functions | Function Signature | |
function validateNumber(supposedNumber[, tuple]): Promise<number || Array> | ||
Examples
1
2
3
import { validateNumber } from "puddy-m/lib/validators";
validateNumber(5.2).then(console.log); // prints '5.2'1
2
3
4
5
import { validateNumber, validateString } from "puddy-m/lib/validators";
validateNumber(-500, [])
.then((tuple) => validateString("foo", tuple))
.then(console.log); // prints [-500, 'foo']1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { validateNumber } from "puddy-m/lib/validators";
const run = async () => {
try {
const number = await validateNumber(333);
console.log(number); // prints 333
} catch (e) {
console.log(e);
}
};
run();1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import { validateNumber } from "puddy-m/lib/validators";
const run = async () => {
try {
const number = await validateNumber("not a number");
console.log(number); // Will throw since arg is not a number
} catch (e) {
// Throws NumberValidationError
console.log(e);
}
};
run();