Skip to content

feat: update namespace TypeScript declarations #2303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions lib/node_modules/@stdlib/array/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
/* eslint-disable max-lines */

import base = require( '@stdlib/array/base' );
import BooleanArray = require( '@stdlib/array/bool' );
import ArrayBuffer = require( '@stdlib/array/buffer' );
import cartesianPower = require( '@stdlib/array/cartesian-power' );
import cartesianProduct = require( '@stdlib/array/cartesian-product' );
Expand Down Expand Up @@ -120,6 +121,70 @@ interface Namespace {
*/
base: typeof base;

/**
* Boolean array constructor.
*
* @param arg - length, typed array, array-like object, or buffer
* @param byteOffset - byte offset (default: 0)
* @param length - view length
* @throws if provided only a single argument, must provide a valid argument
* @throws byte offset must be a nonnegative integer
* @throws must provide sufficient memory to accommodate byte offset and view length requirements
* @returns boolean array
*
* @example
* var arr = new ns.BooleanArray();
* // returns <ns.BooleanArray>
*
* var len = arr.length;
* // returns 0
*
* @example
* var arr = new ns.BooleanArray( 2 );
* // returns <ns.BooleanArray>
*
* var len = arr.length;
* // returns 2
*
* @example
* var arr = new ns.BooleanArray( [ true, false ] );
* // returns <ns.BooleanArray>
*
* var len = arr.length;
* // returns 2
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 16 );
* var arr = new ns.BooleanArray( buf );
* // returns <ns.BooleanArray>
*
* var len = arr.length;
* // returns 16
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 16 );
* var arr = new ns.BooleanArray( buf, 8 );
* // returns <ns.BooleanArray>
*
* var len = arr.length;
* // returns 8
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = new ns.BooleanArray( buf, 8, 2 );
* // returns <ns.BooleanArray>
*
* var len = arr.length;
* // returns 2
*/
BooleanArray: typeof BooleanArray;

/**
* Constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.
*/
Expand Down
6 changes: 0 additions & 6 deletions lib/node_modules/@stdlib/complex/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,13 @@

/* eslint-disable max-lines */

import assert = require( '@stdlib/complex/base/assert' );
import cast = require( '@stdlib/complex/base/cast-return' );
import wrap = require( '@stdlib/complex/base/wrap-function' );

/**
* Interface describing the `base` namespace.
*/
interface Namespace {
/**
* Base complex number assert functions.
*/
assert: typeof assert;

/**
* Wraps an n-ary function and casts a function's return value to a complex number.
*
Expand Down
Loading