All files / assert/is-data-type-object/lib main.js

77.94% Statements 53/68
100% Branches 1/1
0% Functions 0/1
77.94% Lines 53/68

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 691x 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 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 isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var hasProp = require( '@stdlib/assert/has-property' );
var DataType = require( '@stdlib/ndarray/dtype-ctor' );
 
 
// MAIN //
 
/**
* Tests whether an input value is an ndarray data type object.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether an input value is an ndarray data type object
*
* @example
* var DataType = require( '@stdlib/ndarray/dtype-ctor' );
*
* var bool = isDataTypeObject( new DataType( 'float64' ) );
* // returns true
*
* bool = isDataTypeObject( 'float64' );
* // returns false
*
* bool = isDataTypeObject( {} );
* // returns false
*/
function isDataTypeObject( value ) {
	return (
		value instanceof DataType ||
		(
			typeof value === 'object' &&
			value !== null &&
			isInteger( value.alignment ) &&
			isInteger( value.byteLength ) &&
			isString( value.byteOrder ) &&
			isString( value.char ) &&
			isInteger( value.enum ) &&
			hasProp( value, 'value' )
		)
	);
}
 
 
// EXPORTS //
 
module.exports = isDataTypeObject;