Add TypeScript definition

Planeshifter · Planeshifter · commit e9f48638a65d · 2019-01-15T05:50:21.000+01:00
diff --git a/lib/node_modules/@stdlib/math/base/special/ln/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/ln/docs/types/index.d.ts
@@ -0,0 +1,54 @@
+/*
+* @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
+
+// MAIN //
+
+/**
+* Evaluates the natural logarithm.
+*
+* @param {NonNegativeNumber} x - input value
+* @returns {number} function value
+*
+* @example
+* var v = ln( 4.0 );
+* // returns ~1.386
+*
+* @example
+* var v = ln( 0.0 );
+* // returns -Infinity
+*
+* @example
+* var v = ln( Infinity );
+* // returns Infinity
+*
+* @example
+* var v = ln( NaN );
+* // returns NaN
+*
+* @example
+* var v = ln( -4.0 );
+* // returns NaN
+*/
+declare function ln( x: number ): number;
+
+
+// EXPORTS //
+
+export = ln;
diff --git a/lib/node_modules/@stdlib/math/base/special/ln/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/ln/docs/types/test.ts
@@ -0,0 +1,27 @@
+/**
+* @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 ln = require( './index' );
+
+
+// TESTS //
+
+ln( 8 ); // $ExpectType number
+ln( [] ); // $ExpectError
+ln( {} ); // $ExpectError
+ln(); // $ExpectError
diff --git a/lib/node_modules/@stdlib/math/base/special/ln/package.json b/lib/node_modules/@stdlib/math/base/special/ln/package.json
@@ -23,6 +23,7 @@
     "test": "./test"
   },
   "scripts": {},
+  "types": "./docs/types",
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
     "type": "git",
