cast-string
v0.6.4
Published
Cast query string to number and boolean.
Downloads
220
Readme
cast-string
This module allows you to convert URL query strings to numbers and booleans.
Import
ES Module
Import named exports:
import {
int,
float,
number,
bool,
string,
arrayOfInt,
arrayOfFloat,
arrayOfNumber,
arrayOfString,
StringCaster
} from 'cast-string';
const id = int(urlSearchParams.get('id'));
Import default export:
import cast from 'cast-string';
const id = cast.int(urlSearchParams.get('id'));
CommonJS
const {
int,
float,
number,
bool,
string,
arrayOfInt,
arrayOfFloat,
arrayOfNumber,
arrayOfString,
StringCaster
} = require('cast-string');
NOTE: This package is written in ES2020 syntax and has not been transpiled. It has only been tested on Node.js v14+. To use it in older browsers, you will need to transpile the code using a tool such as Babel.
Functions
int
function int(
str: string | null | undefined,
options: {
radix?: number,
default?: number
} = {}
): number | undefined
Convert str
to a number with parseInt()
. If parseInt()
returns NaN
, options.default
is returned.
int('10.1cm')
// -> 10
int('10.1', { radix: 2 })
// -> 2
int('0xA.1')
// -> 10
int('a')
// -> undefined
int('a', { default: 10 })
// -> 10
float
function float(
str: string | null | undefined,
options: { default?: number } = {}
): number | undefined
Convert str
to a number with parseFloat()
.
float('10.1cm')
// -> 10.1
float('0xA.1')
// -> 0
float('a')
// -> undefined
float('a', { default: 10.1 })
// -> 10.1
number
function number(
str: string | null | undefined,
options: { default?: number } = {}
): number | undefined
Convert str
to a number with Number()
.
number('10.1')
// -> 10.1
number('10.1cm')
// -> undefined
number('1e2')
// -> 100
number('a', { default: 10.1 })
// -> 10.1
bool
function bool(
str: string | null | undefined,
options: {
empty?: boolean,
default?: boolean
} = {}
): boolean | undefined
Convert str
to a boolean. Truthy values are '1'
, 'true'
, 'yes'
. Falsy values are '0'
, 'false'
, 'no'
.
If empty
is not false
, the empty string '' is considered a truthy value.
This is useful when dealing with query string parameters, where an empty value typically indicates true
. For example:
const searchParams = new URL('https://www.example.com/list?recursive').searchParams
const isRecursive = bool(searchParams.get('recursive'))
If empty
is false
, the empty string is considered a falsy value.
If str
is neither truthy nor falsy, options.default
is returned.
bool('1')
// -> true
bool('yes')
// -> true
bool('true')
// -> true
bool('')
// -> true
bool('', { empty: false })
// -> false
bool('a')
// -> undefined
bool('a', { default: false })
// -> false
string
function string(
str: string | null | undefined,
options: { default?: string } = {}
): string | undefined
The string function returns the input str
if it is a string.
If str
is null
or undefined
, the function returns the options.default
value, which defaults to undefined
.
string('foo')
// -> 'foo'
string('')
// -> ''
string(undefined)
// -> undefined
string(null)
// -> undefined
string(null, { default: 'a' })
// -> 'a'
arrayOfInt
function arrayOfInt(
str: string | string[] | null | undefined,
options: {
radix?: number,
default?: undefined,
dedup?: boolean,
splitComma?: boolean
} = {}
): number[] | undefined
Convert str
to an array of numbers with parseInt()
.
arrayOfInt(['1', '1cm', '10.1cm', '0xB.1', 'a', null, undefined])
// -> [1, 10, 11]
arrayOfInt(['1', '1cm', '10.1cm', '0xB.1', 'a', null, undefined], { radix: 2, dedup: false })
// -> [1, 1, 2, 0]
arrayOfInt('1')
// -> [1]
arrayOfInt('1,1,2,3', { splitComma: true })
// -> [1, 2, 3]
arrayOfInt(['1,1,2', '3'], { dedup: false, splitComma: true })
// -> [1, 1, 2, 3]
arrayOfInt([])
// -> undefined
arrayOfInt([], { default: [] })
// -> []
arrayOfInt(null)
// -> undefined
arrayOfInt(null, { default: [] })
// -> []
arrayOfFloat
function arrayOfFloat(
str: string | string[] | null | undefined,
options: {
default?: undefined,
dedup?: boolean,
splitComma?: boolean
} = {}
): number[] | undefined
Convert str
to an array of numbers with parseFloat()
.
arrayOfFloat(['1', '1', '10.1', '', null, undefined])
// -> [1, 10.1]
arrayOfFloat(['1', '1', '10.1', '', null, undefined], { dedup: false })
// -> [1, 1, 10.1]
arrayOfFloat([])
// -> undefined
arrayOfFloat([], { default: [] })
// -> []
arrayOfFloat(null)
// -> undefined
arrayOfFloat(null, { default: [] })
// -> []
arrayOfFloat('10.1')
// -> [10.1]
arrayOfFloat('1.1,1.1,2.2,3.3', { splitComma: true })
// -> [1.1, 2.2, 3.3]
arrayOfFloat(['1.1,1.1,2.2', '3.3'], { dedup: false, splitComma: true })
// -> [1.1, 1.1, 2.2, 3.3]
arrayOfNumber
function arrayOfNumber(
str: string | string[] | null | undefined,
options: {
default?: undefined,
dedup?: boolean,
splitComma?: boolean
} = {}
): number[] | undefined
Convert str
to an array of numbers with Number()
.
arrayOfNumber(['1', '1', '1.1', '2cm', '1e2', '', 'a', null, undefined])
// -> [1, 1.1, 100, 0]
arrayOfNumber(['1', '1', '0', '', null, undefined], { dedup: false })
// -> [1, 1, 0, 0]
arrayOfNumber([])
// -> undefined
arrayOfNumber([], { default: [] })
// -> []
arrayOfNumber(null)
// -> undefined
arrayOfNumber(null, { default: [] })
// -> []
arrayOfNumber('10.1')
// -> [10.1]
arrayOfNumber('1.1,1.1,2.2,3.3', { splitComma: true })
// -> [1.1, 2.2, 3.3]
arrayOfNumber(['1.1,1.1,2.2', '3.3'], { dedup: false, splitComma: true })
// -> [1.1, 1.1, 2.2, 3.3]
arrayOfString
function arrayOfString(
str: string | string[] | null | undefined,
options: {
default?: undefined,
dedup?: boolean,
splitComma?: boolean
} = {}
): string[] | undefined
Convert str
to an array of strings.
arrayOfString(['foo', 'foo', '', null, undefined])
// -> ['foo', '']
arrayOfString(['foo', 'foo', '', null, undefined], { dedup: false })
// -> ['foo', 'foo', '']
arrayOfString('foo,foo,bar', { splitComma: true })
// -> ['foo', 'bar']
arrayOfString(['foo,foo,bar', 'baz'], { dedup: false, splitComma: true })
// -> ['foo', 'foo', 'bar', 'baz']
StringCaster
constructor(source:
URLSearchParams |
Record<string, string | string[]> |
(() => URLSearchParams | Record<string, string | string[]>)
)
Create a cast object from source
.
source
can be a URLSearchParams object,
a key-value pair object,
or a function that returns a URLSearchParams or key-value pair object.
const params = new StringCaster(new URLSearchParams('a=1&b=1&b=2&c=1,2,3'))
params.int('a')
// -> 1
params.arrayOfInt('b')
// -> [1, 2]
params.arrayOfInt('c', { splitComma: true })
// -> [1, 2, 3]
const params = new StringCaster({
a: '1',
b: ['1', '2'],
c: '1,2,3'
})
params.int('a')
// -> 1
params.arrayOfInt('b')
// -> [1, 2]
params.arrayOfInt('c', { splitComma: true })
// -> [1, 2, 3]
const params = new StringCaster(() => new URLSearchParams('a=1&b=1&b=2&c=1,2,3'))
params.int('a')
// --> 1
params.arrayOfInt('b')
// -> [1, 2]
params.arrayOfInt('c', { splitComma: true })
// -> [1, 2, 3]