Add examples

kgryte · kgryte · commit b0fdab158472 · 2019-01-17T19:03:02.000-08:00
diff --git a/lib/node_modules/@stdlib/types/index.d.ts b/lib/node_modules/@stdlib/types/index.d.ts
@@ -20,6 +20,18 @@
 
 /**
 * Module containing array definitions.
+*
+* @example
+*
+* import * as array from `@stdlib/types/array`;
+*
+* const x: array.ArrayLike = [ 1, 2, 3 ];
+*
+* @example
+*
+* import { ArrayLike } from `@stdlib/types/array`;
+*
+* const x: ArrayLike = [ 1, 2, 3 ];
 */
 declare module '@stdlib/types/array' {
 	/**
@@ -45,16 +57,31 @@ declare module '@stdlib/types/array' {
 
 	/**
 	* A numeric array.
+	*
+	* @example
+	*
+	* const x: NumericArray = [ 1, 2, 3 ];
+	* const y: NumericArray = new Float64Array( 10 );
 	*/
 	type NumericArray = Array<number> | TypedArray;
 
 	/**
 	* A typed array.
+	*
+	* @example
+	*
+	* const x: TypedArray = new Float64Array( 10 );
+	* const y: TypedArray = new Uint32Array( 10 );
 	*/
 	type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array; // tslint:disable-line:max-line-length
 
 	/**
 	* An integer typed array.
+	*
+	* @example
+	*
+	* const x: IntegerTypedArray = new Uint32Array( 10 );
+	* const y: IntegerTypedArray = new Int32Array( 10 );
 	*/
 	type IntegerTypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array; // tslint:disable-line:max-line-length
 }
