All files / ztest/alternative-resolve-enum/lib main.js

82.45% Statements 47/57
100% Branches 1/1
0% Functions 0/1
82.45% Lines 47/57

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 581x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                     1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 enum2str = require( '@stdlib/stats/base/ztest/alternative-enum2str' );
var str2enum = require( '@stdlib/stats/base/ztest/alternative-str2enum' );
 
 
// MAIN //
 
/**
* Returns the enumeration constant associated with a supported Z-test alternative hypothesis value.
*
* ## Notes
*
* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `TWO_SIDED == 0`). Instead, the function should be used in an opaque manner.
*
* @param {*} value - alternative hypothesis value
* @returns {(integer|null)} enumeration constant or null
*
* @example
* var v = resolve( 'two-sided' );
* // returns <number>
*/
function resolve( value ) {
	var t = ( typeof value );
	if ( t === 'number' ) {
		return ( enum2str( value ) ) ? value : null;
	}
	if ( t === 'string' ) {
		return str2enum( value );
	}
	return null;
}
 
 
// EXPORTS //
 
module.exports = resolve;