Skip to content

Latest commit

 

History

History
125 lines (75 loc) · 2.79 KB

File metadata and controls

125 lines (75 loc) · 2.79 KB

isCompare

Test if an input value is an compare instance.

Usage

var isCompare = require( '@stdlib/plot/vega/base/assert/is-compare' );

isCompare( value )

Tests if an input value is an compare instance.

var Compare = require( '@stdlib/plot/vega/mark/compare' );

var v = new Compare({
    'field': 'amount'
});
var bool = isCompare( v );
// returns true

bool = isCompare( 'foo' );
// returns false

Examples

var Compare = require( '@stdlib/plot/vega/mark/compare' );
var isCompare = require( '@stdlib/plot/vega/base/assert/is-compare' );

var v = new Compare({
    'field': 'amount'
});
var bool = isCompare( v );
// returns true

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

bool = isCompare( 'foo' );
// returns false