feat: docs added

Author: aayush0325

lib/node_modules/@stdlib/math/base/assert/is-oddf/docs/repl.txt

@@ -0,0 +1,33 @@
+
+{{alias}}( x )
+    Tests if a finite single-precision floating-point
+    numeric value is an odd number.
+
+    The function assumes a finite number. If provided positive or negative
+    infinity, the function will return `true`, when, in fact, the result is
+    undefined.
+
+    Parameters
+    ----------
+    x: number
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether the value is an odd number.
+
+    Examples
+    --------
+    > var bool = {{alias}}( 5.0 )
+    true
+    > bool = {{alias}}( -2.0 )
+    false
+    > bool = {{alias}}( 0.0 )
+    false
+    > bool = {{alias}}( NaN )
+    false
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/math/base/assert/is-oddf/docs/types/index.d.ts

@@ -0,0 +1,52 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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: 4.1
+
+/**
+* Tests if a finite single-precision floating-point numeric value is an odd number.
+*
+* ## Notes
+*
+* -   The function assumes a finite number. If provided positive or negative infinity, the function will return `true`, when, in fact, the result is undefined.
+*
+* @param x - value to test
+* @returns boolean indicating whether the value is an odd number
+*
+* @example
+* var bool = isOddf( 5.0 );
+* // returns true
+*
+* @example
+* var bool = isOddf( -2.0 );
+* // returns false
+*
+* @example
+* var bool = isOddf( 0.0 );
+* // returns false
+*
+* @example
+* var bool = isOddf( NaN );
+* // returns false
+*/
+declare function isOddf( x: number ): boolean;
+
+
+// EXPORTS //
+
+export = isOddf;

lib/node_modules/@stdlib/math/base/assert/is-oddf/docs/types/test.ts

@@ -0,0 +1,45 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isOddf = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isOddf( 2 ); // $ExpectType boolean
+	isOddf( 3 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided a value other than a number...
+{
+	isOddf( true ); // $ExpectError
+	isOddf( false ); // $ExpectError
+	isOddf( null ); // $ExpectError
+	isOddf( undefined ); // $ExpectError
+	isOddf( [] ); // $ExpectError
+	isOddf( {} ); // $ExpectError
+	isOddf( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isOddf(); // $ExpectError
+	isOddf( undefined, 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/math/base/assert/is-oddf/test/test.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2024 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.