All files / repl/lib settings_validators.js

89.28% Statements 100/112
100% Branches 1/1
0% Functions 0/4
89.28% Lines 100/112

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 11311x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x       11x 11x 11x 11x 11x 11x 11x 11x 11x       11x 11x 11x 11x 11x 11x 11x 11x 11x       11x 11x 11x 11x 11x 11x 11x 11x 11x       11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x  
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var format = require( '@stdlib/string/format' );
 
 
// FUNCTIONS //
 
/**
* Returns a formatted error message for a value is not a boolean.
*
* @private
* @param {string} name - setting name
* @param {*} value - invalid value
* @returns {string} formatted error message
*/
function booleanErrMsg( name, value ) {
	return format( 'invalid argument. `%s` setting must be a boolean. Value: `%s`.', name, value );
}
 
/**
* Returns a formatted error message for a value is not an integer.
*
* @private
* @param {string} name - setting name
* @param {*} value - invalid value
* @returns {string} formatted error message
*/
function integerErrMsg( name, value ) {
	return format( 'invalid argument. `%s` setting must be an integer. Value: `%s`.', name, value );
}
 
/**
* Returns a formatted error message for a value is not a number.
*
* @private
* @param {string} name - setting name
* @param {*} value - invalid value
* @returns {string} formatted error message
*/
function numberErrMsg( name, value ) {
	return format( 'invalid argument. `%s` setting must be a number. Value: `%s`.', name, value );
}
 
/**
* Returns a formatted error message for a value is not a string.
*
* @private
* @param {string} name - setting name
* @param {*} value - invalid value
* @returns {string} formatted error message
*/
function stringErrMsg( name, value ) {
	return format( 'invalid argument. `%s` setting must be a string. Value: `%s`.', name, value );
}
 
 
// MAIN //
 
/**
* Mapping from data types to validation functions.
*
* @private
* @name VALIDATORS
* @type {Object}
*/
var VALIDATORS = { // eslint-disable-line vars-on-top
	'boolean': {
		'assert': isBoolean,
		'msg': booleanErrMsg
	},
	'integer': {
		'assert': isInteger,
		'msg': integerErrMsg
	},
	'number': {
		'assert': isNumber,
		'msg': numberErrMsg
	},
	'string': {
		'assert': isString,
		'msg': stringErrMsg
	}
};
 
 
// EXPORTS //
 
module.exports = VALIDATORS;