fix: update import path for Collection type definition and improve types

kgryte · kgryte · commit cb8dd5415c30 · 2023-08-18T01:49:11.000-07:00
Ref: stdlib-js@bde4671
diff --git a/lib/node_modules/@stdlib/utils/circular-buffer/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/circular-buffer/docs/types/index.d.ts
@@ -20,13 +20,33 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { IterableIterator } from '@stdlib/types/iter';
-import { Collection } from '@stdlib/types/object';
+import { TypedIterableIterator } from '@stdlib/types/iter';
+import { Collection } from '@stdlib/types/array';
+
+/**
+* Interface describing a JSON-serialized circular buffer.
+*/
+interface JSON<T> {
+	/**
+	* Object type.
+	*/
+	type: 'circular-buffer';
+
+	/**
+	* Number of elements.
+	*/
+	length: number;
+
+	/**
+	* Buffer elements.
+	*/
+	data: Array<T>;
+}
 
 /**
 * Circular buffer.
 */
-declare class CircularBuffer {
+declare class CircularBuffer<T> {
 	/**
 	* Circular buffer constructor.
 	*
@@ -51,7 +71,7 @@ declare class CircularBuffer {
 	* v = b.push( 'boop' );
 	* // returns 'foo'
 	*/
-	constructor( buffer: number | Collection );
+	constructor( buffer: number | Collection<T> );
 
 	/**
 	* Clears the buffer.
@@ -78,7 +98,7 @@ declare class CircularBuffer {
 	* n = b.count;
 	* // returns 0
 	*/
-	clear(): CircularBuffer;
+	clear(): CircularBuffer<T>;
 
 	/**
 	* Number of elements currently in the buffer.
@@ -158,7 +178,7 @@ declare class CircularBuffer {
 	* var bool = it.next().done;
 	* // returns true
 	*/
-	iterator( niters?: number ): IterableIterator;
+	iterator( niters?: number ): TypedIterableIterator<T>;
 
 	/**
 	* Circular buffer length (i.e., capacity).
@@ -175,6 +195,7 @@ declare class CircularBuffer {
 	/**
 	* Adds a value to the circular buffer.
 	*
+	* @param value - value to add
 	* @returns removed element or undefined
 	*
 	* @example
@@ -194,7 +215,7 @@ declare class CircularBuffer {
 	* v = b.push( 'boop' );
 	* // returns 'foo'
 	*/
-	push(): any;
+	push( value: T ): T;
 
 	/**
 	* Returns an array of circular buffer values.
@@ -214,7 +235,7 @@ declare class CircularBuffer {
 	* var vals = b.toArray();
 	* // returns [ 'bar', 'beep', 'boop' ]
 	*/
-	toArray(): Array<any>;
+	toArray(): Array<T>;
 
 	/**
 	* Serializes a circular buffer as JSON.
@@ -238,7 +259,7 @@ declare class CircularBuffer {
 	* var o = b.toJSON();
 	* // returns { 'type': 'circular-buffer', 'length': 3, 'data': [ 'bar', 'beep', 'boop' ] }
 	*/
-	toJSON(): any;
+	toJSON(): JSON<T>;
 }
 
 
diff --git a/lib/node_modules/@stdlib/utils/circular-buffer/docs/types/test.ts b/lib/node_modules/@stdlib/utils/circular-buffer/docs/types/test.ts
@@ -21,11 +21,14 @@
 import CircularBuffer = require( './index' );
 
 
+// FIXME: add tests
+
+
 // TESTS //
 
 // The function returns a circular buffer instance...
 {
-	new CircularBuffer( 3 ); // $ExpectType CircularBuffer
+	new CircularBuffer( 3 ); // $ExpectType CircularBuffer<unknown>
 }
 
 // The compiler throws an error if the constructor function is provided an invalid number of arguments...

Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,14 @@`
`21`	`21`	`import CircularBuffer = require( './index' );`
`22`	`22`
`23`	`23`
	`24`	`+// FIXME: add tests`
	`25`	`+`
	`26`	`+`
`24`	`27`	`// TESTS //`
`25`	`28`
`26`	`29`	`// The function returns a circular buffer instance...`
`27`	`30`	`{`
`28`		`- new CircularBuffer( 3 ); // $ExpectType CircularBuffer`
	`31`	`+ new CircularBuffer( 3 ); // $ExpectType CircularBuffer<unknown>`
`29`	`32`	`}`
`30`	`33`
`31`	`34`	`// The compiler throws an error if the constructor function is provided an invalid number of arguments...`