@@ -74,13 +74,15 @@ type Predicate<T, U> = NullaryPredicate<U> | UnaryPredicate<T, U> | BinaryPredic
7474*
7575* @template T - queue element type
7676*/
77- declare class FIFO < T = any > {
77+ declare class FIFO < T = unknown > {
7878 /**
7979 * First-in-first-out queue constructor.
8080 *
8181 * @returns FIFO queue instance
8282 *
8383 * @example
84+ * var FIFO = require( '@stdlib/dstructs/fifo' );
85+ *
8486 * var queue = new FIFO();
8587 *
8688 * // Add values to the queue:
@@ -105,6 +107,8 @@ declare class FIFO<T = any> {
105107 * @returns queue instance
106108 *
107109 * @example
110+ * var FIFO = require( '@stdlib/dstructs/fifo' );
111+ *
108112 * var queue = new FIFO();
109113 *
110114 * // Add values to the queue:
@@ -144,6 +148,8 @@ declare class FIFO<T = any> {
144148 * @returns boolean indicating whether all elements pass a test
145149 *
146150 * @example
151+ * var FIFO = require( '@stdlib/dstructs/fifo' );
152+ *
147153 * function predicate( v ) {
148154 * return v > 0;
149155 * }
@@ -163,6 +169,8 @@ declare class FIFO<T = any> {
163169 * @returns "oldest" queue value
164170 *
165171 * @example
172+ * var FIFO = require( '@stdlib/dstructs/fifo' );
173+ *
166174 * var queue = new FIFO();
167175 *
168176 * // Add values to the queue:
@@ -182,6 +190,8 @@ declare class FIFO<T = any> {
182190 * @returns queue element
183191 *
184192 * @example
193+ * var FIFO = require( '@stdlib/dstructs/fifo' );
194+ *
185195 * var queue = new FIFO();
186196 *
187197 * queue.push( 'foo' ).push( 'bar' );
@@ -204,6 +214,8 @@ declare class FIFO<T = any> {
204214 * @returns iterator
205215 *
206216 * @example
217+ * var FIFO = require( '@stdlib/dstructs/fifo' );
218+ *
207219 * var queue = new FIFO();
208220 *
209221 * // Add values to the queue:
@@ -230,6 +242,8 @@ declare class FIFO<T = any> {
230242 * @returns "newest" queue value
231243 *
232244 * @example
245+ * var FIFO = require( '@stdlib/dstructs/fifo' );
246+ *
233247 * var queue = new FIFO();
234248 *
235249 * // Add values to the queue:
@@ -245,6 +259,8 @@ declare class FIFO<T = any> {
245259 * Queue length.
246260 *
247261 * @example
262+ * var FIFO = require( '@stdlib/dstructs/fifo' );
263+ *
248264 * var queue = new FIFO();
249265 *
250266 * // Examine the initial queue length:
@@ -266,6 +282,8 @@ declare class FIFO<T = any> {
266282 * @returns removed value
267283 *
268284 * @example
285+ * var FIFO = require( '@stdlib/dstructs/fifo' );
286+ *
269287 * var queue = new FIFO();
270288 *
271289 * // Add values to the queue:
@@ -290,6 +308,8 @@ declare class FIFO<T = any> {
290308 * @returns queue instance
291309 *
292310 * @example
311+ * var FIFO = require( '@stdlib/dstructs/fifo' );
312+ *
293313 * var queue = new FIFO();
294314 *
295315 * // Add values to the queue:
@@ -322,6 +342,8 @@ declare class FIFO<T = any> {
322342 * @throws target queue lacks sufficient storage to accommodate source values
323343 *
324344 * @example
345+ * var FIFO = require( '@stdlib/dstructs/fifo' );
346+ *
325347 * var queue = new FIFO();
326348 *
327349 * queue.push( 'foo' ).push( 'bar' ).set( 'beep', 0 );
@@ -347,6 +369,8 @@ declare class FIFO<T = any> {
347369 * @returns queue values
348370 *
349371 * @example
372+ * var FIFO = require( '@stdlib/dstructs/fifo' );
373+ *
350374 * var queue = new FIFO();
351375 *
352376 * // Add values to the queue:
@@ -368,6 +392,8 @@ declare class FIFO<T = any> {
368392 * @returns serialized queue
369393 *
370394 * @example
395+ * var FIFO = require( '@stdlib/dstructs/fifo' );
396+ *
371397 * var queue = new FIFO();
372398 *
373399 * // Add values to the queue:
@@ -377,7 +403,7 @@ declare class FIFO<T = any> {
377403 * var o = queue.toJSON();
378404 * // returns { 'type': 'fifo', 'data': [ 'foo', 'bar' ] }
379405 */
380- toJSON ( ) : any ;
406+ toJSON ( ) : { type : string ; data : Array < T > } ;
381407}
382408
383409
0 commit comments