Package Exports

dstructs-array-constructors

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dstructs-array-constructors) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Array Constructors

Returns an array constructor corresponding to an array data type.

Installation

$ npm install dstructs-array-constructors

For use in the browser, use browserify.

Usage

var getCtor = require( 'dstructs-array-constructors' );

getCtor( dtype )

Returns an array constructor corresponding to an array data type.

var ctor = getCtor( 'int8' );
// returns Int8Array

The following array data types are supported:

Data Type	Constructor
int8	`Int8Array`
uint8	`Uint8Array`
uint8_clamped	`Uint8ClampedArray`
int16	`Int16Array`
uint16	`Uint16Array`
int32	`Int32Array`
uint32	`Uint32Array`
float32	`Float32Array`
float64	`Float64Array`
generic	`Array`

Examples

var getCtor = require( 'dstructs-array-constructors' );

console.log( getCtor( 'int8' ) );
// returns Int8Array

console.log( getCtor( 'uint8' ) );
// returns Uint8Array

console.log( getCtor( 'uint8_clamped' ) );
// returns Uint8ClampedArray

console.log( getCtor( 'int16' ) );
// returns Int16Array

console.log( getCtor( 'uint16' ) );
// returns Uint16Array

console.log( getCtor( 'int32' ) );
// returns Int32Array

console.log( getCtor( 'uint32' ) );
// returns Uint32Array

console.log( getCtor( 'float32' ) );
// returns Float32Array

console.log( getCtor( 'float64' ) );
// returns Float64Array

console.log( getCtor( 'generic' ) );
// returns Array

console.log( getCtor( null ) );
// returns null

console.log( getCtor( 'object' ) );
// returns null

console.log( getCtor( 'array' ) );
// returns null

console.log( getCtor( {} ) );
// returns null

console.log( getCtor( [] ) );
// returns null

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

dstructs-array-constructors