History

NunoSempere b6addc7f05 feat: add the node modules Necessary in order to clearly see the squiggle hotwiring.		2022-12-03 12:44:49 +00:00
..
docs	feat: add the node modules	2022-12-03 12:44:49 +00:00
lib	feat: add the node modules	2022-12-03 12:44:49 +00:00
package.json	feat: add the node modules	2022-12-03 12:44:49 +00:00
README.md	feat: add the node modules	2022-12-03 12:44:49 +00:00

README.md

isIndexMode

Test if an input value is a supported ndarray index mode.

Usage

var isIndexMode = require( '@stdlib/ndarray/base/assert/is-index-mode' );

isIndexMode( value )

Tests if an input value is a supported ndarray index mode.

var bool = isIndexMode( 'throw' );
// returns true

bool = isIndexMode( 'clamp' );
// returns true

bool = isIndexMode( 'wrap' );
// returns true

Examples

var isIndexMode = require( '@stdlib/ndarray/base/assert/is-index-mode' );

var bool = isIndexMode( 'throw' );
// returns true

bool = isIndexMode( 'wrap' );
// returns true

bool = isIndexMode( 'clamp' );
// returns true

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

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