Add examples

kgryte · kgryte · commit 870889b4d991 · 2017-06-16T19:23:14.000-07:00
diff --git a/lib/node_modules/@stdlib/types/typed-array/factory/lib/index.js b/lib/node_modules/@stdlib/types/typed-array/factory/lib/index.js
@@ -53,8 +53,43 @@
 * var typedarray = require( '@stdlib/types/typed-array/factory' );
 *
 * var buf = new ArrayBuffer( 16 );
-* var arr = typedarray( buf, 0, 4, 'int32' );
-* // returns <Int32Array>[ 0, 0, 0, 0 ]
+* var arr = typedarray( buf );
+* // returns <Float64Array>[ 0.0, 0.0 ]
+*
+* @example
+* var typedarray = require( '@stdlib/types/typed-array/factory' );
+*
+* var buf = new ArrayBuffer( 16 );
+* var arr = typedarray( buf, 'float32' );
+* // returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
+*
+* @example
+* var typedarray = require( '@stdlib/types/typed-array/factory' );
+*
+* var buf = new ArrayBuffer( 16 );
+* var arr = typedarray( buf, 8 );
+* // returns <Float64Array>[ 0.0 ]
+*
+* @example
+* var typedarray = require( '@stdlib/types/typed-array/factory' );
+*
+* var buf = new ArrayBuffer( 16 );
+* var arr = typedarray( buf, 8, 'float32' );
+* // returns <Float32Array>[ 0.0, 0.0 ]
+*
+* @example
+* var typedarray = require( '@stdlib/types/typed-array/factory' );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = typedarray( buf, 8, 2 );
+* // returns <Float64Array>[ 0.0, 0.0 ]
+*
+* @example
+* var typedarray = require( '@stdlib/types/typed-array/factory' );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = typedarray( buf, 8, 2, 'int32' );
+* // returns <Int32Array>[ 0, 0 ]
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/types/typed-array/factory/lib/typedarray.js b/lib/node_modules/@stdlib/types/typed-array/factory/lib/typedarray.js
@@ -50,8 +50,33 @@ var CTORS = require( './ctors.js' );
 *
 * @example
 * var buf = new ArrayBuffer( 16 );
-* var arr = typedarray( buf, 0, 4, 'int32' );
-* // returns <Int32Array>[ 0, 0, 0, 0 ]
+* var arr = typedarray( buf );
+* // returns <Float64Array>[ 0.0, 0.0 ]
+*
+* @example
+* var buf = new ArrayBuffer( 16 );
+* var arr = typedarray( buf, 'float32' );
+* // returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
+*
+* @example
+* var buf = new ArrayBuffer( 16 );
+* var arr = typedarray( buf, 8 );
+* // returns <Float64Array>[ 0.0 ]
+*
+* @example
+* var buf = new ArrayBuffer( 16 );
+* var arr = typedarray( buf, 8, 'float32' );
+* // returns <Float32Array>[ 0.0, 0.0 ]
+*
+* @example
+* var buf = new ArrayBuffer( 32 );
+* var arr = typedarray( buf, 8, 2 );
+* // returns <Float64Array>[ 0.0, 0.0 ]
+*
+* @example
+* var buf = new ArrayBuffer( 32 );
+* var arr = typedarray( buf, 8, 2, 'int32' );
+* // returns <Int32Array>[ 0, 0 ]
 */
 function typedarray() {
 	var nargs;
