test.js

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var tape = require( 'tape' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var modes = require( './../lib' );


// TESTS //

tape( 'main export is a function', function test( t ) {
	t.ok( true, __filename );
	t.strictEqual( typeof modes, 'function', 'main export is a function' );
	t.end();
});

tape( 'the function returns a list of ndarray index modes', function test( t ) {
	var expected;
	var actual;

	expected = [
		'throw',
		'clamp',
		'wrap'
	];
	actual = modes();

	t.deepEqual( actual, expected, 'returns expected value' );
	t.end();
});

tape( 'attached to the main function is an `enum` method to return an object mapping index modes to integer values for C inter-operation', function test( t ) {
	var obj;
	var m;
	var i;

	t.strictEqual( hasOwnProp( modes, 'enum' ), true, 'has property' );
	t.strictEqual( typeof modes.enum, 'function', 'has method' );

	obj = modes.enum();
	t.strictEqual( typeof obj, 'object', 'returns expected value type' );

	// List of index modes which should be supported...
	m = [
		'throw',
		'clamp',
		'wrap'
	];
	for ( i = 0; i < m.length; i++ ) {
		t.strictEqual( hasOwnProp( obj, m[ i ] ), true, 'has property `' + m[ i ] + '`' );
		t.strictEqual( isNonNegativeInteger( obj[ m[i] ] ), true, 'returns expected value' );
	}

	t.end();
});