Add Typescript definition

Planeshifter · Planeshifter · commit a2649af8551e · 2020-01-19T14:47:10.000-05:00
diff --git a/lib/node_modules/@stdlib/stats/incr/msummary/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/msummary/docs/types/index.d.ts
@@ -0,0 +1,139 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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.
+*/
+
+// TypeScript Version: 2.0
+
+/// <reference types="@stdlib/types"/>
+
+interface Summary {
+	/**
+	* Window size.
+	*/
+	window: number;
+
+	/**
+	* Maximum value.
+	*/
+	max: number;
+
+	/**
+	* Minimum value.
+	*/
+	min: number;
+
+	/**
+	* Range.
+	*/
+	range: number;
+
+	/**
+	* Mid-range.
+	*/
+	midrange: number;
+
+	/**
+	* Sum.
+	*/
+	sum: number;
+
+	/**
+	* Arithmetic mean.
+	*/
+	mean: number;
+
+	/**
+	* Unbiased sample variance.
+	*/
+	variance: number;
+
+	/**
+	* Corrected sample standard deviation.
+	*/
+	stdev: number;
+
+	/**
+	* Corrected sample skewness.
+	*/
+	skewness: number;
+
+	/**
+	* Corrected sample excess kurtosis.
+	*/
+	kurtosis: number;
+}
+
+
+/**
+* If provided a value, the accumulator function returns an updated summary; otherwise, the accumulator function returns the current summary.
+*
+* ## Notes
+*
+* -   The returned summary is an object containing the following fields:
+*
+*     -   window: window size.
+*     -   max: maximum value.
+*     -   min: minimum value.
+*     -   range: range.
+*     -   midrange: mid-range.
+*     -   sum: sum.
+*     -   mean: arithmetic mean.
+*     -   variance: unbiased sample variance.
+*     -   stdev: corrected sample standard deviation.
+*     -   skewness: corrected sample skewness.
+*     -   kurtosis: corrected sample excess kurtosis.
+*
+*
+* @param x - value
+* @returns updated summary
+*/
+type accumulator = ( x?: number ) => Summary | null;
+
+/**
+* Returns an accumulator function which incrementally computes a moving statistical summary.
+*
+* ## Notes
+*
+* -   The `W` parameter defines the number of values over which to compute the moving statistical summary.
+* -   If provided a value, the accumulator function returns an updated moving statistical summary. If not provided a value, the accumulator function returns the current moving statistical summary.
+* -   As `W` values are needed to fill the window buffer, the first `W-1` returned summaries are calculated from smaller sample sizes. Until the window is full, each returned summary is calculated from all provided values.
+*
+* @param W - window size
+* @throws must provide a positive integer
+* @returns accumulator function
+*
+* @example
+* var accumulator = incrmsummary( 3 );
+*
+* var summary = accumulator();
+* // returns {}
+*
+* summary = accumulator( 2.0 );
+* // returns {...}
+*
+* summary = accumulator( -5.0 );
+* // returns {...}
+*
+* summary = accumulator();
+* // returns {...}
+*/
+declare function incrmsummary( W: number ): accumulator;
+
+
+// EXPORTS //
+
+export = incrmsummary;
diff --git a/lib/node_modules/@stdlib/stats/incr/msummary/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/msummary/docs/types/test.ts
@@ -0,0 +1,66 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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.
+*/
+
+import incrmsummary = require( './index' );
+
+
+// TESTS //
+
+// The function returns an accumulator function...
+{
+	incrmsummary( 3 ); // $ExpectType accumulator
+}
+
+// The compiler throws an error if the function is provided an argument which is not a number...
+{
+	incrmsummary( '5' ); // $ExpectError
+	incrmsummary( true ); // $ExpectError
+	incrmsummary( false ); // $ExpectError
+	incrmsummary( null ); // $ExpectError
+	incrmsummary( undefined ); // $ExpectError
+	incrmsummary( [] ); // $ExpectError
+	incrmsummary( {} ); // $ExpectError
+	incrmsummary( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	incrmsummary(); // $ExpectError
+	incrmsummary( 3, 2 ); // $ExpectError
+}
+
+// The function returns an accumulator function which returns a summary object...
+{
+	const acc = incrmsummary( 3 );
+
+	acc(); // $ExpectType Summary | null
+	acc( 3.14 ); // $ExpectType Summary | null
+}
+
+// The compiler throws an error if the returned accumulator function is provided invalid arguments...
+{
+	const acc = incrmsummary( 3 );
+
+	acc( '5' ); // $ExpectError
+	acc( true ); // $ExpectError
+	acc( false ); // $ExpectError
+	acc( null ); // $ExpectError
+	acc( [] ); // $ExpectError
+	acc( {} ); // $ExpectError
+	acc( ( x: number ): number => x ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/stats/incr/msummary/package.json b/lib/node_modules/@stdlib/stats/incr/msummary/package.json
@@ -20,6 +20,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
