♻️ refactor: Improve docstrings.

Author: make-github-pseudonymous-again

src/Tape.js

@@ -9,12 +9,12 @@ export default class Tape {
 	/**
 	 * The constructor. Stores the callable that yields values to put on the tape.
 	 *
-	 * @param {Callable} callable - The callable to use.
+	 * @param {Function} callable - The callable to use.
 	 */
 	constructor(callable) {
 		/**
 		 * The callable yielding values to put on the tape.
-		 * @type {Callable}
+		 * @type {Function}
 		 */
 		this.callable = callable;
 
@@ -26,7 +26,7 @@ export default class Tape {
 
 		/**
 		 * The eof symbol.
-		 * @type {String}
+		 * @type {any}
 		 */
 		this.eof = eof;
 	}
@@ -35,7 +35,7 @@ export default class Tape {
 	 * Returns the next token on the tape or {@link Tape#eof}
 	 * if the tape has been exhausted.
 	 *
-	 * @returns {Object} The next token on the tape or {@link Tape#eof}.
+	 * @returns {Promise} The next token on the tape or {@link Tape#eof}.
 	 */
 	async read() {
 		if (this.buffer.length > 0) return this.buffer.pop();
@@ -51,7 +51,7 @@ export default class Tape {
 	 * Puts a token back on the tape. If {@link Tape#read} is
 	 * used just after, this token will be returned.
 	 *
-	 * @param {Object} token - The token to put back on the tape.
+	 * @param {any} token - The token to put back on the tape.
 	 */
 	unread(token) {
 		// Should this be async too ?
@@ -69,7 +69,7 @@ export default class Tape {
 	/**
 	 * Skip the next `n` tokens on the tape.
 	 *
-	 * @param {Number} n - The number of tokens to skip.
+	 * @param {number} n - The number of tokens to skip.
 	 */
 	async skipMany(n) {
 		while (n-- > 0) await this.skip(); // eslint-disable-line no-await-in-loop

src/asyncIterableChain.js

@@ -2,7 +2,7 @@
  * Utility function to chain an async iterable of async iterables.
  *
  * @private
- * @param {AsyncIterable} iterables - the input iterable of iterables.
+ * @param {AsyncIterable<AsyncIterable>} iterables - the input iterable of iterables.
  * @returns {AsyncIterable} The chain of the input iterables.
  */
 export default async function* asyncIterableChain(iterables) {

src/asyncIterableMap.js

@@ -2,7 +2,7 @@
  * Utility function to apply a sync callable to each item of an async iterable.
  *
  * @private
- * @param {Callable} callable - The callable to apply.
+ * @param {Function} callable - The callable to apply.
  * @param {AsyncIterable} iterable - The iterable to process.
  * @returns {AsyncIterable} The iterable of mapped values.
  */

src/asyncIterableToArray.js

@@ -3,7 +3,7 @@
  *
  * @private
  * @param {AsyncIterable} asyncIterable - the input iterable.
- * @returns {Array} A new array filled with the elements of the input iterable.
+ * @returns {Promise<any[]>} A new array filled with the elements of the input iterable.
  */
 export default async function asyncIterableToArray(asyncIterable) {
 	const array = [];

src/chain.js

@@ -6,7 +6,7 @@ import asyncIterableMap from './asyncIterableMap.js';
 /**
  * Converts a tape of tapes of tokens to a tape of tokens.
  * @param {Tape} tape - The tape of tapes of tokens to read from.
- * @return {Tape} The converted tape of tokens.
+ * @returns {Tape} The converted tape of tokens.
  */
 export default function chain(tape) {
 	return fromAsyncIterable(

src/eof.js

@@ -1,4 +1,7 @@
 /**
  * Shared object used as end of file.
+ *
+ * @type {object}
  */
-export default {};
+const eof = {};
+export default eof;

src/fromArray.js

@@ -4,7 +4,8 @@ import fromIterable from './fromIterable.js';
  * Converts an array to a tape.
  *
  * @function
- * @param {Array} _array - the array to convert
+ * @param {Array} array - the array to convert
  * @returns {Tape}
  */
-export default fromIterable;
+const fromArray = fromIterable;
+export default fromArray;

src/fromCallable.js

@@ -4,7 +4,7 @@ import Tape from './Tape.js';
  * Converts a callable to a tape.
  *
  * @function
- * @param {Callable} callable - The callable to convert.
+ * @param {Function} callable - The callable to convert.
  * @returns {Tape} The converted tape.
  */
 export default (callable) => new Tape(callable);

src/fromIterator.js

@@ -4,7 +4,7 @@ import fromCallable from './fromCallable.js';
  * Converts an iterator to a tape.
  *
  * @function
- * @param {Iterator} iterator - The iterator to convert.
+ * @param {Iterator|AsyncIterator} iterator - The iterator to convert.
  * @returns {Tape} The converted tape.
  */
 export default (iterator) => fromCallable(iterator.next.bind(iterator));

src/fromString.js

@@ -7,7 +7,8 @@ import fromIterable from './fromIterable.js';
  * fromString( '1,3,2' ) ;
  *
  * @function
- * @param {String} _string - the string to convert
+ * @param {string} string - the string to convert
  * @returns {Tape}
  */
-export default fromIterable;
+const fromString = fromIterable;
+export default fromString;