feat: add MultiSlice interface

kgryte · kgryte · commit 3af398c171b2 · 2023-09-13T23:06:45.000-07:00
diff --git a/lib/node_modules/@stdlib/types/index.d.ts b/lib/node_modules/@stdlib/types/index.d.ts
@@ -2886,6 +2886,8 @@ declare module '@stdlib/types/utilities' {
 * const s: slice.Slice = { 'start': 0, 'stop': 10, 'step': 1 };
 */
 declare module '@stdlib/types/slice' {
+	import { ArrayLike } from '@stdlib/types/array';
+
 	/**
 	* A slice object.
 	*
@@ -2908,4 +2910,22 @@ declare module '@stdlib/types/slice' {
 		*/
 		step: V;
 	}
+
+	/**
+	* A multi-slice object.
+	*
+	* @example
+	* const s: MultiSlice = { 'ndims': 1, 'data': [ 10 ] };
+	*/
+	interface MultiSlice {
+		/**
+		* Number of slice dimensions.
+		*/
+		ndims: number;
+
+		/**
+		* Slice data.
+		*/
+		data: ArrayLike<Slice | number | null>;
+	}
 }
diff --git a/lib/node_modules/@stdlib/types/test.ts b/lib/node_modules/@stdlib/types/test.ts
@@ -666,4 +666,12 @@ function cmplx128Array(): array.Complex128Array {
 	if ( v6.start !== v6.start ) {
 		throw new Error( 'something went wrong' );
 	}
+
+	const v7: slice.MultiSlice = {
+		'ndims': 3,
+		'data': [ 1, null, 3 ]
+	};
+	if ( v7.ndims !== v7.ndims ) {
+		throw new Error( 'something went wrong' );
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -666,4 +666,12 @@ function cmplx128Array(): array.Complex128Array {`
`666`	`666`	`if ( v6.start !== v6.start ) {`
`667`	`667`	`throw new Error( 'something went wrong' );`
`668`	`668`	`}`
	`669`	`+`
	`670`	`+ const v7: slice.MultiSlice = {`
	`671`	`+ 'ndims': 3,`
	`672`	`+ 'data': [ 1, null, 3 ]`
	`673`	`+ };`
	`674`	`+ if ( v7.ndims !== v7.ndims ) {`
	`675`	`+ throw new Error( 'something went wrong' );`
	`676`	`+ }`
`669`	`677`	`}`