External module "ndarray/base/assert/is-index-mode/docs/types/index.d"

Export assignment isIndexMode

• isIndexMode(v: any): boolean

• Tests whether an input value is a supported ndarray index mode.

  Parameters

  • v: any

    value to test

  Returns boolean

  boolean indicating whether an input value is a supported ndarray index mode

  Example

  var bool = isIndexMode( 'wrap' );
  // returns true
  
  bool = isIndexMode( 'clamp' );
  // returns true
  
  bool = isIndexMode( 'throw' );
  // returns true
  
  bool = isIndexMode( 'foo' );
  // returns false