feat(/lib/node_modules/@stdlib/iter/cartesian-square): added docs folder

Signed-off-by: vinayak <fobo401@gmail.com>

lib/node_modules/@stdlib/iter/cartesian-square/docs/repl.txt

@@ -0,0 +1,33 @@
+{{alias}}( x )
+    Returns an iterator which generates the Cartesian square of an input
+    array-like object. If an environment supports Symbol.iterator, the returned
+    iterator is iterable.
+
+    Parameters
+    ----------
+     x : collection
+        Input array-like object.
+
+    Returns
+    -------
+    iterator: Object
+        Iterator.
+
+    iterator.next(): Function
+        Returns an iterator protocol-compliant object containing the next
+        iterated value (if one exists) and a boolean flag indicating whether the
+        iterator is finished.
+
+    iterator.return( [value] ): Function
+        Finishes an iterator and returns a provided value.
+
+    Examples
+    --------
+    > var it = {{alias}}( [ '1', '2', '3' ] )
+    > var v = it.next().value
+    [ '1', '1' ]
+    > v = it.next().value
+    [ '1', '2' ]
+
+    See Also
+    --------

lib/node_modules/@stdlib/iter/cartesian-square/docs/types/index.d.ts

@@ -0,0 +1,60 @@
+/*
+* @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
+
+/// <reference types="@stdlib/types"/>
+
+import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
+import { ArrayLike } from '@stdlib/types/array';
+
+// Define a union type representing both iterable and non-iterable iterators:
+type Iterator = Iter | IterableIterator;
+
+/**
+* Returns an iterator which generates the Cartesian square of an input array-like object.
+*
+* @param x - Input array-like object.
+* @throws {TypeError} first argument must be an array-like object
+* @returns iterator
+*
+* @example
+* var iterCartesianSquare = require( '@stdlib/iter/cartesian-square' );
+*
+* var iterator = iterCartesianSquare( [ 'a', 'b', 'c' ] );
+* // returns <Object>
+*
+* var v = iterator.next().value;
+* // returns [ 'a', 'a' ]
+*
+* v = iterator.next().value;
+* // returns [ 'a', 'b' ]
+*
+* v = iterator.next().value;
+* // returns [ 'a', 'c' ]
+*
+* // ...
+*
+* var bool = iterator.next().done;
+* // returns true
+*/
+declare function iterCartesianSquare<T>( x: ArrayLike<T> | Iterable<T> ): Iterator;
+
+// EXPORTS //
+
+export = iterCartesianSquare;

lib/node_modules/@stdlib/iter/cartesian-square/docs/types/test.ts

@@ -0,0 +1,43 @@
+/*
+* @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 iterCartesianSquare = require( './index' );
+
+// TESTS //
+
+// The function returns an iterator...
+{
+	iterCartesianSquare( [ 'a', 'b', 'c' ] ); // $ExpectType Iterator
+	iterCartesianSquare( [ 1, 2, 3 ] ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided an argument which is not an array-like object...
+{
+	iterCartesianSquare( 5 ); // $ExpectError
+	iterCartesianSquare( true ); // $ExpectError
+	iterCartesianSquare( false ); // $ExpectError
+	iterCartesianSquare( null ); // $ExpectError
+	iterCartesianSquare( {} ); // $ExpectError
+	iterCartesianSquare( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	iterCartesianSquare(); // $ExpectError
+}
+