README.md

isGridAlignment

Test if an input value is a supported grid alignment.

Usage

var isGridAlignment = require( '@stdlib/plot/vega/base/assert/is-grid-alignment' );

isGridAlignment( value )

Tests if an input value is a supported grid alignment.

var bool = isGridAlignment( 'all' );
// returns true

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

Examples

var isGridAlignment = require( '@stdlib/plot/vega/base/assert/is-grid-alignment' );

var bool = isGridAlignment( 'all' );
// returns true

bool = isGridAlignment( 'each' );
// returns true

bool = isGridAlignment( '' );
// returns false

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