coerce
helper to coerce value to expected type
useful to parse query-string parameters
Install
npm install type-coerce
Usage
let coerce = require('type-coerce')let val = coerce.int('123')// val = 123 let arr = coerce.array('a,b,c')// val = ['a', 'b', 'c']
API
- on success: => coerced value
- on failure: =>
undefined
Number
, an integer
coerce.int(val) => Number
coerce.floar(val) => true
or false
coerce.bool(val) => true
,'true'
,'True'
,'TRUE'
,'1'
,1
returnstrue
false
,'false'
,'False'
,'FALSE'
,'0'
,0
returnsfalse
- anything else fails the coercion
String
coerce.string(val) => - if
val
isstring
=>val
- otherwise, =>
util.inspect(val)
coerce.array(val, elemT, sep) => Array of String
- val:
string
: parse into Array, split bysep
, parse element byelemT
null
,undefined
:undefined
Array
: parse elements withelemT
- otherwise,
[val]
- sep: explicitly specify separator,
string
orRegExp
- default:
\s*,\s*
, this splits string with,
and trims spaces
- default:
- elemT: element parser,
(str)=>element
- a function that parses array element
- default:
coerce.any
sep
orelemT
can be omitted, or passed in reverse order
(val)=>coerce.array(val, sep, elemT)
coerce.typedArray(sep, elemT) => - create a partial initialized function to use later
- take
sep
,elemT
as arguments
val
coerce.any(val) => - =>
val
Date
coerce.date(val) => val
is passed tonew Date()
LICENSE
MIT (C) wacky6/Jiewei Qian