Add Typescript definition

Author: Planeshifter

lib/node_modules/@stdlib/ndarray/base/numel/docs/types/index.d.ts

@@ -0,0 +1,40 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/// <reference types="@stdlib/types"/>
+
+import { ArrayLike } from '@stdlib/types/array';
+
+/**
+* Returns the number of elements in an array.
+*
+* @param shape - array shape
+* @returns number of elements
+*
+* @example
+* var n = numel( [ 3, 3, 3 ] );
+* // returns 27
+*/
+declare function numel( shape: ArrayLike<number> ): number;
+
+
+// EXPORTS //
+
+export = numel;

lib/node_modules/@stdlib/ndarray/base/numel/docs/types/test.ts

@@ -0,0 +1,44 @@
+/*
+* @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.
+*/
+
+import numel = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	numel( [ 3, 2, 1 ] ); // $ExpectType number
+}
+
+// The function does not compile if provided a value other than an array-like object containing numbers...
+{
+	numel( true ); // $ExpectError
+	numel( false ); // $ExpectError
+	numel( null ); // $ExpectError
+	numel( undefined ); // $ExpectError
+	numel( '5' ); // $ExpectError
+	numel( [ '1', '2' ] ); // $ExpectError
+	numel( {} ); // $ExpectError
+	numel( ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if provided insufficient arguments...
+{
+	numel(); // $ExpectError
+}

lib/node_modules/@stdlib/ndarray/base/numel/package.json

@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {