set-funcs
A very limited subset of set-* functions I use every day
Install
npm i set-funcs
Package on npm
API
setBoolean(data, [fallback])
Check if data
is a Boolean
If yes, return data
otherwise return fallback
Argument | Action |
---|---|
data | the tested data |
fallback | optional fallback , default to false |
const setBoolean = { opts = opts || {} // option silent will be `true` if not defined optssilent = }
setNumber(data, [fallback], [min], [max])
Check if data
is a Number
If yes, return data
otherwise return fallback
data
can be clamped between min
and max
Argument | Action |
---|---|
data | the tested data |
fallback | optional fallback , default to 0 |
min | optional min . If defined, data will be clamped to it |
max | optional max . If defined, data will be clamped to it |
const setNumber = { opts = opts || {} // option `delay` will be `50` if not defined optsdelay = // option `time` will be 25 min optstime = }
setString(data, [fallback], [allowed])
Check if data
is a String
If yes, return data
otherwise return fallback
allowed
can be a string or an array of accepted values. If data
is not found in allowed
, the fallback
is returned
Argument | Action |
---|---|
data | the tested data |
fallback | optional fallback , default to '' |
allowed | optional allowed . String or Array of accepted values |
const setString = { opts = opts || {} // option `ignore` can be 'resize' or 'scroll', fallback to 'resize' optsignore = // using the array form optsignore = }
License
MIT