About

xyjax-required-value is the lightweight and standalone package which provides validation and/or data mapping in easily-reusable way. This package was originally developed for Xyjax NPM package.

Methods

There is one method you can import:

1. requiredValue(source, requiredValue, requireCondition)

Maps, validates or filter given value in a simply-reusable way.

Arguments description:

• source is the source data for check or mapping
• requiredValue is the value will be returned in case of requireCondition(source) == true or mapping function. If requiredValue is mapping function (which is function with one parameter) requiredValue(source) evaluation result will be returned in any case.
• requireCondition is the function with one parameter which determines if source or required value will be returned (if requireCondition returns true requiredValue will be returned, source otherwise). This parameter does not make any sense if requiredValue is mapping function!

Usage example

Click here to take a look at RunKit + NPM embed example.

import { requiredValue } from 'xyjax-required-value'

// required value will be returned in case of source is less than 10
var test1 = requiredValue(2, 5, source => source < 10) //5
// required value will be returned in case of source is greater than 10
var test2 = requiredValue(2, 5, source => source > 10) //2
// if requiredData is a function then mapped source will be returned (source + 10 in this case)
var test3 = requiredValue(2, source => source + 10) //12
// by default requireCondition is:
// source => source == null || source == undefined
var test4 = requiredValue(2, 5) //2
var test5 = requiredValue(null, 5) //5