asg-cnv-str-to-num v1.0.3

asg-cnv-str-to-num

Convert a string to its numerical value (float or integer)

Table of Contents

• Why?
• Installation
• Functions
• Usage
• License

Why?

I needed a simple way to parse string numbers to its matching numerical value, for parsing csv formatted files.

Installation

$ npm i asg-cnv-str-to-num -S

or

$ yarn add asg-cnv-str-to-num

Functions

Take a look into the usage section for a detailed example.

convertStringToNumber

Note: you can also use the default export.

This function converts a string to its numerical value (float, int, or NaN).

Syntax

Returns a number or NaN.

const number = convertStringToNumber(value);

Parameters

• value: a string

Usage

An example how to use it.

const { convertStringToNumber } = require('asg-cnv-str-to-num'); // named export
const converter = require('asg-cnv-str-to-num'); // default export

const int = convertStringToNumber('2'); // => 2
const float = converter('2.2'); // => 2.2
const notANumber = converter('franz'); // => NaN

License

MIT © AsG