Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

Author: kgryte

.github/workflows/update_namespace_definitions.yml

@@ -0,0 +1,76 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2021 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.
+#/
+
+# Workflow name:
+name: update_namespace_definitions
+
+# Workflow triggers:
+on:
+  # Allow the workflow to be manually run:
+  workflow_dispatch:
+
+# Workflow jobs:
+jobs:
+
+  # Define a job for pushing changes to standalone packages...
+  update:
+
+    # Define a display name:
+    name: "Update Namespace Typescript Definitions"
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define the sequence of job steps...
+    steps:
+
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v2
+        with:
+          # Specify whether to remove untracked files before checking out the repository:
+          clean: true
+
+          # Limit clone depth to the most recent commit:
+          fetch-depth: 1
+
+          # Specify whether to download Git-LFS files:
+          lfs: false
+        timeout-minutes: 10
+
+      # Install Node.js:
+      - name: 'Install Node.js'
+        uses: actions/setup-node@v2
+        with:
+          node-version: 15
+        timeout-minutes: 5
+
+      # Install dependencies:
+      - name: 'Install dependencies'
+        run: |
+          make install-node-modules
+        timeout-minutes: 15
+
+      # Update namespace Typescript definitions:
+      - name: 'Update namespace Typescript definitions'
+        run: |
+          make list-pkgs-namespaces | node lib/node_modules/@stdlib/_tools/scripts/create_namespace_types.js
+
+      # Create a pull request with the updated definitions:
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3

lib/node_modules/@stdlib/_tools/scripts/create_namespace_types.js

@@ -26,6 +26,10 @@
 
 var path = require( 'path' );
 var fs = require( 'fs' );
+var contains = require( '@stdlib/assert/contains' );
+var stdin = require( '@stdlib/process/read-stdin' );
+var stdinStream = require( '@stdlib/streams/node/stdin' );
+var reEOL = require( '@stdlib/regexp/eol' );
 var removePunctuation = require( '@stdlib/string/remove-punctuation' );
 var readJSON = require( '@stdlib/fs/read-json' ).sync;
 var replace = require( '@stdlib/string/replace' );
@@ -141,12 +145,13 @@ function createDefinitionFile( ns, imports, properties, description ) {
 }
 
 /**
-* Main execution sequence.
+* Creates Typescript definition and test files for the namespace ass.
 *
 * @private
+* @param {string} fullPath - full namespace name
 * @returns {void}
 */
-function main() {
+function create( fullPath ) {
 	var RE_DOC_MAIN_DECLARE;
 	var nsIdentifier;
 	var description;
@@ -156,8 +161,8 @@ function main() {
 	var properties;
 	var indexFile;
 	var tsDefPath;
-	var fullPath;
 	var testFile;
+	var typesDir;
 	var defFile;
 	var pkgPath;
 	var match;
@@ -171,15 +176,17 @@ function main() {
 	var ns;
 	var RE;
 
-	fullPath = process.argv[ 2 ];
-	ns = path.basename( fullPath );
 	importStmts = [];
 	properties = [];
 
+	ns = path.basename( fullPath );
 	entryPoint = require.resolve( fullPath );
 	indexFile = fs.readFileSync( entryPoint, 'utf-8' );
 	console.log( 'Loading '+entryPoint+'...' );
 
+	if ( !RE_NAMESPACE.test( indexFile ) ) {
+		return;
+	}
 	nsIdentifier = RE_NAMESPACE.exec( indexFile )[ 1 ];
 	nsIdentifier = removePunctuation( nsIdentifier );
 	RE = new RegExp( 'setReadOnly\\( '+nsIdentifier+', \'([a-z0-9_]+)\', require\\( \'([^\']+)\' \\) \\)', 'ig' );
@@ -213,6 +220,15 @@ function main() {
 				str = replace( str, '\n', '\n\t' );
 				prop = '\t' + str + '\n' + prop;
 			}
+			else {
+				tsDoc = tsDef.match( /(\/\*\*\n[\s\S]+?\*\/)\nexport =/ );
+				if ( tsDoc && tsDoc[ 1 ] ) {
+					str = tsDoc[ 1 ];
+					str = replace( str, RE_EXAMPLE, onReplace );
+					str = replace( str, '\n', '\n\t' );
+					prop = '\t' + str + '\n' + prop;
+				}
+			}
 			match = RE.exec( indexFile );
 			if ( match ) {
 				prop += '\n';
@@ -225,13 +241,18 @@ function main() {
 	fullPath = path.join( entryPoint, '..', '..' );
 	description = readJSON( path.join( fullPath, 'package.json' ) ).description;
 
+	typesDir = path.join( fullPath, 'docs', 'types' );
+	if ( !fs.existsSync( typesDir ) ) {
+		return;
+	}
+
 	console.log( 'Writing definition file...' );
 	defFile = createDefinitionFile( ns, importStmts, properties, description );
-	fs.writeFileSync( path.join( fullPath, 'docs/types/index.d.ts' ), defFile );
+	fs.writeFileSync( path.join( typesDir, 'index.d.ts' ), defFile );
 
 	console.log( 'Writing test file...' );
 	testFile = createTestFile( ns );
-	fs.writeFileSync( path.join( fullPath, 'docs/types/test.ts' ), testFile );
+	fs.writeFileSync( path.join( typesDir, 'test.ts' ), testFile );
 
 	/**
 	* Replaces variable names inside of example code to use exported namespace methods.
@@ -249,4 +270,40 @@ function main() {
 	}
 }
 
+/**
+* Callback invoked upon reading from `stdin`.
+*
+* @private
+* @param {(Error|null)} error - error object
+* @param {Buffer} data - data
+* @returns {void}
+*/
+function onRead( error, data ) {
+	var lines;
+	var i;
+	if ( error ) {
+		return console.error( error.message );
+	}
+	lines = data.toString().split( reEOL.REGEXP );
+	for ( i = 0; i < lines.length; i++ ) {
+		if ( lines[ i ] && !contains( lines[ i ], '_tools' ) ) {
+			create( lines[ i ] );
+		}
+	}
+}
+
+/**
+* Main execution sequence.
+*
+* @private
+* @returns {void}
+*/
+function main() {
+	// Check if we are receiving data from `stdin`...
+	if ( !stdinStream.isTTY ) {
+		return stdin( onRead );
+	}
+	create( process.argv[ 2 ] );
+}
+
 main();

lib/node_modules/@stdlib/array/docs/types/index.d.ts

@@ -28,15 +28,19 @@ import convertArray = require( '@stdlib/array/convert' );
 import convertArraySame = require( '@stdlib/array/convert-same' );
 import arrayCtors = require( '@stdlib/array/ctors' );
 import DataView = require( '@stdlib/array/dataview' );
+import datespace = require( '@stdlib/array/datespace' );
 import arrayDataType = require( '@stdlib/array/dtype' );
 import arrayDataTypes = require( '@stdlib/array/dtypes' );
 import filledarray = require( '@stdlib/array/filled' );
 import Float32Array = require( '@stdlib/array/float32' );
 import Float64Array = require( '@stdlib/array/float64' );
 import iterator2array = require( '@stdlib/array/from-iterator' );
+import incrspace = require( '@stdlib/array/incrspace' );
 import Int8Array = require( '@stdlib/array/int8' );
 import Int16Array = require( '@stdlib/array/int16' );
 import Int32Array = require( '@stdlib/array/int32' );
+import linspace = require( '@stdlib/array/linspace' );
+import logspace = require( '@stdlib/array/logspace' );
 import arrayMinDataType = require( '@stdlib/array/min-dtype' );
 import arrayNextDataType = require( '@stdlib/array/next-dtype' );
 import typedarraypool = require( '@stdlib/array/pool' );
@@ -266,6 +270,36 @@ interface Namespace {
 	*/
 	DataView: typeof DataView;
 
+	/**
+	* Generates an array of linearly spaced dates.
+	*
+	* @param start - start time as either a `Date` object, Unix timestamp, JavaScript timestamp, or date string
+	* @param stop - stop time as either a `Date` object, Unix timestamp, JavaScript timestamp, or date string
+	* @param length - output array length (default: 100)
+	* @param options - function options
+	* @param options.round - specifies how sub-millisecond times should be rounded: [ 'floor', 'ceil', 'round' ] (default: 'floor' )
+	* @throws length argument must a positive integer
+	* @throws must provide valid options
+	* @returns array of dates
+	*
+	* @example
+	* var stop = '2014-12-02T07:00:54.973Z';
+	* var start = new Date( stop ) - 60000;
+	*
+	* var arr = ns.datespace( start, stop, 6 );
+	* // returns [...]
+	*
+	* @example
+	* // Equivalent of Math.ceil():
+	* var arr = ns.datespace( 1417503655000, 1417503655001, 3, { 'round': 'ceil' } );
+	* // returns [...]
+	*
+	* // Equivalent of Math.round():
+	* var arr = ns.datespace( 1417503655000, 1417503655001, 3, { 'round': 'round' } );
+	* // returns [...]
+	*/
+	datespace: typeof datespace;
+
 	/**
 	* Returns the data type of an array.
 	*
@@ -359,6 +393,21 @@ interface Namespace {
 	*/
 	iterator2array: typeof iterator2array;
 
+	/**
+	* Generates a linearly spaced numeric array using a provided increment.
+	*
+	* @param x1 - first array value
+	* @param x2 - array element bound
+	* @param increment - increment (default: 1)
+	* @throws length of created array must be less than `4294967295` (`2**32 - 1`)
+	* @returns linearly spaced numeric array
+	*
+	* @example
+	* var arr = ns.incrspace( 0, 11, 2 );
+	* // returns [ 0, 2, 4, 6, 8, 10 ]
+	*/
+	incrspace: typeof incrspace;
+
 	/**
 	* Typed array constructor which returns a typed array representing an array of twos-complement 8-bit signed integers in the platform byte order.
 	*/
@@ -374,6 +423,36 @@ interface Namespace {
 	*/
 	Int32Array: typeof Int32Array;
 
+	/**
+	* Generates a linearly spaced numeric array.
+	*
+	* @param x1 - first array value
+	* @param x2 - last array value
+	* @param len - length of output array (default: 100)
+	* @throws third argument must be a nonnegative integer
+	* @returns linearly spaced numeric array
+	*
+	* @example
+	* var arr = ns.linspace( 0, 100, 6 );
+	* // returns [ 0, 20, 40, 60, 80, 100 ]
+	*/
+	linspace: typeof linspace;
+
+	/**
+	* Generates a logarithmically spaced numeric array.
+	*
+	* @param a - exponent of start value
+	* @param b - exponent of end value
+	* @param len - length of output array (default: 10)
+	* @throws third argument must be a nonnegative integer
+	* @returns logarithmically spaced numeric array
+	*
+	* @example
+	* var arr = ns.logspace( 0, 2, 6 );
+	* // returns [ 1, ~2.5, ~6.31, ~15.85, ~39.81, 100 ]
+	*/
+	logspace: typeof logspace;
+
 	/**
 	* Returns the minimum array data type of the closest "kind" necessary for storing a provided scalar value.
 	*

lib/node_modules/@stdlib/assert/docs/types/index.d.ts

@@ -26,6 +26,7 @@ import deepEqual = require( '@stdlib/assert/deep-equal' );
 import deepHasOwnProp = require( '@stdlib/assert/deep-has-own-property' );
 import deepHasProp = require( '@stdlib/assert/deep-has-property' );
 import hasArrayBufferSupport = require( '@stdlib/assert/has-arraybuffer-support' );
+import hasArrowFunctionSupport = require( '@stdlib/assert/has-arrow-function-support' );
 import hasAsyncAwaitSupport = require( '@stdlib/assert/has-async-await-support' );
 import hasAsyncIteratorSymbolSupport = require( '@stdlib/assert/has-async-iterator-symbol-support' );
 import hasBigIntSupport = require( '@stdlib/assert/has-bigint-support' );
@@ -76,6 +77,7 @@ import isArrayLike = require( '@stdlib/assert/is-array-like' );
 import isArrayLikeObject = require( '@stdlib/assert/is-array-like-object' );
 import isArrayBuffer = require( '@stdlib/assert/is-arraybuffer' );
 import isArrayBufferView = require( '@stdlib/assert/is-arraybuffer-view' );
+import isArrowFunction = require( '@stdlib/assert/is-arrow-function' );
 import isASCII = require( '@stdlib/assert/is-ascii' );
 import isBetween = require( '@stdlib/assert/is-between' );
 import isBetweenArray = require( '@stdlib/assert/is-between-array' );
@@ -473,6 +475,17 @@ interface Namespace {
 	*/
 	hasArrayBufferSupport: typeof hasArrayBufferSupport;
 
+	/**
+	* Tests for native arrow function support.
+	*
+	* @returns boolean indicating if an environment has native arrow function support
+	*
+	* @example
+	* var bool = ns.hasArrowFunctionSupport();
+	* // returns <boolean>
+	*/
+	hasArrowFunctionSupport: typeof hasArrowFunctionSupport;
+
 	/**
 	* Tests for native `async/await` support.
 	*
@@ -1266,6 +1279,27 @@ interface Namespace {
 	*/
 	isArrayBufferView: typeof isArrayBufferView;
 
+	/**
+	* Tests if a value is an arrow function.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is an arrow function
+	*
+	* @example
+	* var arrow = () => {};
+	* var bool = ns.isArrowFunction( arrow );
+	* // returns true
+	*
+	* @example
+	* function beep() {
+	*     return 'beep';
+	* }
+	
+	* var bool = ns.isArrowFunction( beep );
+	* // returns false
+	*/
+	isArrowFunction: typeof isArrowFunction;
+
 	/**
 	* Tests whether a character belongs to the ASCII character set and whether this is true for all characters in a provided string.
 	*

lib/node_modules/@stdlib/buffer/docs/types/index.d.ts

@@ -60,7 +60,7 @@ interface Namespace {
 	* var ctor = require( `@stdlib/buffer/ctor` );
 	*
 	* var b = new ctor( [ 1, 2, 3, 4 ] );
-	* // returns <Buffer>
+	* // returns <ns.Buffer>
 	*/
 	Buffer: typeof Buffer;