Add type definition

Author: Planeshifter

lib/node_modules/@stdlib/complex/reim/docs/types/index.d.ts

@@ -0,0 +1,52 @@
+/*
+* @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 { ComplexLike } from '@stdlib/types/object';
+
+/**
+* Returns the real and imaginary components of a complex number.
+*
+* @param z - complex number
+* @returns real and imaginary components
+*
+* @example
+* var Complex128 = require( `@stdlib/complex/float64` );
+*
+* var z = new Complex128( 5.0, 3.0 );
+*
+* var out = reim( z );
+* // returns <Float64Array>[ 5.0, 3.0 ]
+*
+* @example
+* var Complex64 = require( `@stdlib/complex/float32` );
+*
+* var z = new Complex64( 5.0, 3.0 );
+*
+* var out = reim( z );
+* // returns <Float32Array>[ 5.0, 3.0 ]
+*/
+declare function reim( z: ComplexLike ): Float64Array | Float32Array;
+
+
+// EXPORTS //
+
+export = reim;

lib/node_modules/@stdlib/complex/reim/docs/types/test.ts

@@ -0,0 +1,48 @@
+/*
+* @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 reim = require( './index' );
+import Complex128 = require( '@stdlib/complex/float64' );
+import Complex64 = require( '@stdlib/complex/float32' );
+
+
+// TESTS //
+
+// The function returns a floating-point typed array...
+{
+	reim( new Complex128( 5.0, 3.0 ) ); // $ExpectType Float64Array | Float32Array
+	reim( new Complex64( 5.0, 3.0 ) ); // $ExpectType Float64Array | Float32Array
+	reim( { 're': 5.0, 'im': 3.0 } ); // $ExpectType Float64Array | Float32Array
+}
+
+// The compiler throws an error if the function is provided an argument that is not a complex number...
+{
+	reim( 'abc' ); // $ExpectError
+	reim( 123 ); // $ExpectError
+	reim( true ); // $ExpectError
+	reim( false ); // $ExpectError
+	reim( [] ); // $ExpectError
+	reim( {} ); // $ExpectError
+	reim( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	reim(); // $ExpectError
+	reim( new Complex128( 5.0, 3.0 ), 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/complex/reim/package.json

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