Home Original page

stdlib/lib/node_modules/@stdlib/assert/is-struct at develop · stdlib-js/stdlib

isStruct

Test if a value is a struct instance.

Usage

var isStruct = require( '@stdlib/assert/is-struct' );

isStruct( value )

Tests if a value is a struct instance.

var structFactory = require( '@stdlib/dstructs/struct' );

var schema = [
    {
        'name': 'value',
        'type': 'float64'
    }
];
var Struct = structFactory( schema );

var bool = isStruct( new Struct() );
// returns true

Examples

var structFactory = require( '@stdlib/dstructs/struct' );
var isStruct = require( '@stdlib/assert/is-struct' );

var schema = [
    {
        'name': 'value',
        'type': 'float64'
    }
];
var Struct = structFactory( schema );

var bool = isStruct( new Struct() );
// returns true

bool = isStruct( [ 1, 2, 3, 4 ] );
// returns false

bool = isStruct( {} );
// returns false

bool = isStruct( null );
// returns false

See Also