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

86.4% Statements 89/103
100% Branches 1/1
0% Functions 0/1
86.4% Lines 89/103

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 1041x 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 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 isDataTypeObject = require( '@stdlib/ndarray/base/assert/is-data-type-object' );
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
var isFunction = require( '@stdlib/assert/is-function' );
 
 
// MAIN //
 
/**
* Tests whether an input value is a supported ndarray struct data type.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether an input value is a supported ndarray struct data type
*
* @example
* var structFactory = require( '@stdlib/dstructs/struct' );
*
* var Struct = structFactory([
*     {
*         'name': 'foo',
*         'type': 'float64'
*     }
* ]);
*
* var bool = isStructDataType( Struct );
* // returns true
*
* bool = isStructDataType( 'binary' );
* // returns false
*
* bool = isStructDataType( 'float32' );
* // returns false
*
* bool = isStructDataType( 'float64' );
* // returns false
*
* bool = isStructDataType( 'generic' );
* // returns false
*
* bool = isStructDataType( 'int16' );
* // returns false
*
* bool = isStructDataType( 'int32' );
* // returns false
*
* bool = isStructDataType( 'int8' );
* // returns false
*
* bool = isStructDataType( 'uint16' );
* // returns false
*
* bool = isStructDataType( 'uint32' );
* // returns false
*
* bool = isStructDataType( 'uint8' );
* // returns false
*
* bool = isStructDataType( 'uint8c' );
* // returns false
*
* bool = isStructDataType( 'foo' );
* // returns false
*/
function isStructDataType( value ) {
	return (
		isFunction( value ) &&
		isPositiveInteger( value.alignment ) &&
		isPositiveInteger( value.byteLength ) &&
		isFunction( value.byteLengthOf ) &&
		isFunction( value.byteOffsetOf ) &&
		isFunction( value.bufferOf ) &&
		isFunction( value.viewOf )
	) || (
		isDataTypeObject( value ) &&
		isStructDataType( value.value )
	);
}
 
 
// EXPORTS //
 
module.exports = isStructDataType;