Merge branch 'develop'

Author: robertleeplummerjr

README.md

@@ -38,6 +38,8 @@ Or alternatively you can experiment around with the [kernel playground here](htt
 
 # Table of Contents
 
+NOTE: documentation is slightly out of date for the upcoming release of v2.  We will fix it!  In the mean time, if you'd like to assist (PLEASE) let us know.
+
 * [Installation](#installation)
 * [`GPU` Settings](#gpu-settings)
 * [`gpu.createKernel` Settings](#gpu-createkernel-settings)

src/index.d.ts

@@ -11,12 +11,12 @@ export class GPU {
   constructor(settings?: IGPUSettings);
   functions: IGPUFunction[];
   nativeFunctions: IGPUNativeFunction[];
-  addFunction(kernel: KernelFunction, settings?: IGPUFunctionSettings);
-  addNativeFunction(name: string, source: string);
-  combineKernels(): KernelFunction;
+  addFunction(kernel: KernelFunction, settings?: IGPUFunctionSettings): this;
+  addNativeFunction(name: string, source: string): this;
+  combineKernels(...kernels: Function[]): KernelFunction;
   createKernel(kernel: KernelFunction, settings?: IKernelSettings): IKernelRunShortcut;
-  createKernelMap(): IKernelRunShortcut;
-  destroy();
+  createKernelMap(subKernels: Object | Array<Function>, rootKernel: Function): IKernelRunShortcut;
+  destroy(): void;
   Kernel: typeof Kernel;
   mode: string;
   canvas: any;
@@ -136,8 +136,8 @@ export class Kernel {
   ): KernelVariable
   toJSON(): object;
   exec(): Promise<KernelOutput>;
-  setOutput(flag): this;
-  setArgumentTypes(flag): this;
+  setOutput(flag: any): this;
+  setArgumentTypes(flag: any): this;
   setDebug(flag: boolean): this;
   setGraphical(flag: boolean): this;
   setLoopMaxIterations(flag: number): this;
@@ -286,7 +286,7 @@ export interface ISubKernel {
 export class FunctionBuilder {
   fromKernel(kernel: IKernelSettings, FunctionNode: FunctionNode, extraNodeOptions?: any): FunctionBuilder;
   constructor(settings: IFunctionBuilderSettings);
-  addFunctionNode(functionNode: FunctionNode);
+  addFunctionNode(functionNode: FunctionNode): void;
   traceFunctionCalls(functionName: string): string[];
   getStringFromFunctionNames(functionName?: string[]): string;
   getPrototypesFromFunctionNames(functionName?: string[]): string[];