@ckeditor/ckeditor5-utils 35.3.2 → 36.0.0

package/src/collection.js

@@ -1,11 +1,11 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
  * @module utils/collection
  */
-import { Emitter } from './emittermixin';
+import EmitterMixin from './emittermixin';
 import CKEditorError from './ckeditorerror';
 import uid from './uid';
 import isIterable from './isiterable';
@@ -19,45 +19,9 @@ import isIterable from './isiterable';
  * By default an item in the collection is identified by its `id` property. The name of the identifier can be
  * configured through the constructor of the collection.
  *
- * @mixes module:utils/emittermixin~EmitterMixin
+ * @typeParam T The type of the collection element.
  */
-export default class Collection extends Emitter {
-    /**
-     * Creates a new Collection instance.
-     *
-     * You can provide an iterable of initial items the collection will be created with:
-     *
-     *		const collection = new Collection( [ { id: 'John' }, { id: 'Mike' } ] );
-     *
-     *		console.log( collection.get( 0 ) ); // -> { id: 'John' }
-     *		console.log( collection.get( 1 ) ); // -> { id: 'Mike' }
-     *		console.log( collection.get( 'Mike' ) ); // -> { id: 'Mike' }
-     *
-     * Or you can first create a collection and then add new items using the {@link #add} method:
-     *
-     *		const collection = new Collection();
-     *
-     *		collection.add( { id: 'John' } );
-     *		console.log( collection.get( 0 ) ); // -> { id: 'John' }
-     *
-     * Whatever option you choose, you can always pass a configuration object as the last argument
-     * of the constructor:
-     *
-     *		const emptyCollection = new Collection( { idProperty: 'name' } );
-     *		emptyCollection.add( { name: 'John' } );
-     *		console.log( collection.get( 'John' ) ); // -> { name: 'John' }
-     *
-     *		const nonEmptyCollection = new Collection( [ { name: 'John' } ], { idProperty: 'name' } );
-     *		nonEmptyCollection.add( { name: 'George' } );
-     *		console.log( collection.get( 'George' ) ); // -> { name: 'George' }
-     *		console.log( collection.get( 'John' ) ); // -> { name: 'John' }
-     *
-     * @param {Iterable.<Object>|Object} [initialItemsOrOptions] The initial items of the collection or
-     * the options object.
-     * @param {Object} [options={}] The options object, when the first argument is an array of initial items.
-     * @param {String} [options.idProperty='id'] The name of the property which is used to identify an item.
-     * Items that do not have such a property will be assigned one when added to the collection.
-     */
+export default class Collection extends EmitterMixin() {
     constructor(initialItemsOrOptions = {}, options = {}) {
         super();
         const hasInitialItems = isIterable(initialItemsOrOptions);
@@ -80,24 +44,18 @@ export default class Collection extends Emitter {
     }
     /**
      * The number of items available in the collection.
-     *
-     * @member {Number} #length
      */
     get length() {
         return this._items.length;
     }
     /**
      * Returns the first item from the collection or null when collection is empty.
-     *
-     * @returns {Object|null} The first item or `null` if collection is empty.
      */
     get first() {
         return this._items[0] || null;
     }
     /**
      * Returns the last item from the collection or null when collection is empty.
-     *
-     * @returns {Object|null} The last item or `null` if collection is empty.
      */
     get last() {
         return this._items[this.length - 1] || null;
@@ -107,9 +65,8 @@ export default class Collection extends Emitter {
      *
      * If the item does not have an id, then it will be automatically generated and set on the item.
      *
-     * @chainable
-     * @param {Object} item
-     * @param {Number} [index] The position of the item in the collection. The item
+     * @param item
+     * @param index The position of the item in the collection. The item
      * is pushed to the collection when `index` not specified.
      * @fires add
      * @fires change
@@ -122,9 +79,8 @@ export default class Collection extends Emitter {
      *
      * Any item not containing an id will get an automatically generated one.
      *
-     * @chainable
-     * @param {Iterable.<Object>} items
-     * @param {Number} [index] The position of the insertion. Items will be appended if no `index` is specified.
+     * @param items
+     * @param index The position of the insertion. Items will be appended if no `index` is specified.
      * @fires add
      * @fires change
      */
@@ -160,8 +116,8 @@ export default class Collection extends Emitter {
     /**
      * Gets an item by its ID or index.
      *
-     * @param {String|Number} idOrIndex The item ID or index in the collection.
-     * @returns {Object|null} The requested item or `null` if such item does not exist.
+     * @param idOrIndex The item ID or index in the collection.
+     * @returns The requested item or `null` if such item does not exist.
      */
     get(idOrIndex) {
         let item;
@@ -184,8 +140,8 @@ export default class Collection extends Emitter {
     /**
      * Returns a Boolean indicating whether the collection contains an item.
      *
-     * @param {Object|String} itemOrId The item or its ID in the collection.
-     * @returns {Boolean} `true` if the collection contains the item, `false` otherwise.
+     * @param itemOrId The item or its ID in the collection.
+     * @returns `true` if the collection contains the item, `false` otherwise.
      */
     has(itemOrId) {
         if (typeof itemOrId == 'string') {
@@ -201,8 +157,8 @@ export default class Collection extends Emitter {
      * Gets an index of an item in the collection.
      * When an item is not defined in the collection, the index will equal -1.
      *
-     * @param {Object|String} itemOrId The item or its ID in the collection.
-     * @returns {Number} The index of a given item.
+     * @param itemOrId The item or its ID in the collection.
+     * @returns The index of a given item.
      */
     getIndex(itemOrId) {
         let item;
@@ -217,8 +173,8 @@ export default class Collection extends Emitter {
     /**
      * Removes an item from the collection.
      *
-     * @param {Object|Number|String} subject The item to remove, its ID or index in the collection.
-     * @returns {Object} The removed item.
+     * @param subject The item to remove, its ID or index in the collection.
+     * @returns The removed item.
      * @fires remove
      * @fires change
      */
@@ -234,11 +190,10 @@ export default class Collection extends Emitter {
     /**
      * Executes the callback for each item in the collection and composes an array or values returned by this callback.
      *
-     * @param {Function} callback
-     * @param {Object} callback.item
-     * @param {Number} callback.index
-     * @param {Object} [ctx] Context in which the `callback` will be called.
-     * @returns {Array} The result of mapping.
+     * @typeParam U The result type of the callback.
+     * @param callback
+     * @param ctx Context in which the `callback` will be called.
+     * @returns The result of mapping.
      */
     map(callback, ctx) {
         return this._items.map(callback, ctx);
@@ -246,11 +201,9 @@ export default class Collection extends Emitter {
     /**
      * Finds the first item in the collection for which the `callback` returns a true value.
      *
-     * @param {Function} callback
-     * @param {Object} callback.item
-     * @param {Number} callback.index
-     * @param {Object} [ctx] Context in which the `callback` will be called.
-     * @returns {Object|undefined} The item for which `callback` returned a true value.
+     * @param callback
+     * @param ctx Context in which the `callback` will be called.
+     * @returns The item for which `callback` returned a true value.
      */
     find(callback, ctx) {
         return this._items.find(callback, ctx);
@@ -258,11 +211,9 @@ export default class Collection extends Emitter {
     /**
      * Returns an array with items for which the `callback` returned a true value.
      *
-     * @param {Function} callback
-     * @param {Object} callback.item
-     * @param {Number} callback.index
-     * @param {Object} [ctx] Context in which the `callback` will be called.
-     * @returns {Array} The array with matching items.
+     * @param callback
+     * @param ctx Context in which the `callback` will be called.
+     * @returns The array with matching items.
      */
     filter(callback, ctx) {
         return this._items.filter(callback, ctx);
@@ -294,96 +245,111 @@ export default class Collection extends Emitter {
      *
      * The binding can be a simple factory:
      *
-     *		class FactoryClass {
-     *			constructor( data ) {
-     *				this.label = data.label;
-     *			}
-     *		}
+     * ```ts
+     * class FactoryClass {
+     * 	public label: string;
      *
-     *		const source = new Collection( { idProperty: 'label' } );
-     *		const target = new Collection();
+     * 	constructor( data: { label: string } ) {
+     * 		this.label = data.label;
+     * 	}
+     * }
      *
-     *		target.bindTo( source ).as( FactoryClass );
+     * const source = new Collection<{ label: string }>( { idProperty: 'label' } );
+     * const target = new Collection<FactoryClass>();
      *
-     *		source.add( { label: 'foo' } );
-     *		source.add( { label: 'bar' } );
+     * target.bindTo( source ).as( FactoryClass );
      *
-     *		console.log( target.length ); // 2
-     *		console.log( target.get( 1 ).label ); // 'bar'
+     * source.add( { label: 'foo' } );
+     * source.add( { label: 'bar' } );
      *
-     *		source.remove( 0 );
-     *		console.log( target.length ); // 1
-     *		console.log( target.get( 0 ).label ); // 'bar'
+     * console.log( target.length ); // 2
+     * console.log( target.get( 1 ).label ); // 'bar'
+     *
+     * source.remove( 0 );
+     * console.log( target.length ); // 1
+     * console.log( target.get( 0 ).label ); // 'bar'
+     * ```
      *
      * or the factory driven by a custom callback:
      *
-     *		class FooClass {
-     *			constructor( data ) {
-     *				this.label = data.label;
-     *			}
-     *		}
+     * ```ts
+     * class FooClass {
+     * 	public label: string;
+     *
+     * 	constructor( data: { label: string } ) {
+     * 		this.label = data.label;
+     * 	}
+     * }
      *
-     *		class BarClass {
-     *			constructor( data ) {
-     *				this.label = data.label;
-     *			}
-     *		}
+     * class BarClass {
+     * 	public label: string;
      *
-     *		const source = new Collection( { idProperty: 'label' } );
-     *		const target = new Collection();
+     * 	constructor( data: { label: string } ) {
+     * 		this.label = data.label;
+     * 	}
+     * }
      *
-     *		target.bindTo( source ).using( ( item ) => {
-     *			if ( item.label == 'foo' ) {
-     *				return new FooClass( item );
-     *			} else {
-     *				return new BarClass( item );
-     *			}
-     *		} );
+     * const source = new Collection<{ label: string }>( { idProperty: 'label' } );
+     * const target = new Collection<FooClass | BarClass>();
      *
-     *		source.add( { label: 'foo' } );
-     *		source.add( { label: 'bar' } );
+     * target.bindTo( source ).using( ( item ) => {
+     * 	if ( item.label == 'foo' ) {
+     * 		return new FooClass( item );
+     * 	} else {
+     * 		return new BarClass( item );
+     * 	}
+     * } );
      *
-     *		console.log( target.length ); // 2
-     *		console.log( target.get( 0 ) instanceof FooClass ); // true
-     *		console.log( target.get( 1 ) instanceof BarClass ); // true
+     * source.add( { label: 'foo' } );
+     * source.add( { label: 'bar' } );
+     *
+     * console.log( target.length ); // 2
+     * console.log( target.get( 0 ) instanceof FooClass ); // true
+     * console.log( target.get( 1 ) instanceof BarClass ); // true
+     * ```
      *
      * or the factory out of property name:
      *
-     *		const source = new Collection( { idProperty: 'label' } );
-     *		const target = new Collection();
+     * ```ts
+     * const source = new Collection<{ nested: { value: string } }>();
+     * const target = new Collection<{ value: string }>();
      *
-     *		target.bindTo( source ).using( 'label' );
+     * target.bindTo( source ).using( 'nested' );
      *
-     *		source.add( { label: { value: 'foo' } } );
-     *		source.add( { label: { value: 'bar' } } );
+     * source.add( { nested: { value: 'foo' } } );
+     * source.add( { nested: { value: 'bar' } } );
      *
-     *		console.log( target.length ); // 2
-     *		console.log( target.get( 0 ).value ); // 'foo'
-     *		console.log( target.get( 1 ).value ); // 'bar'
+     * console.log( target.length ); // 2
+     * console.log( target.get( 0 ).value ); // 'foo'
+     * console.log( target.get( 1 ).value ); // 'bar'
+     * ```
      *
-     * It's possible to skip specified items by returning falsy value:
+     * It's possible to skip specified items by returning null value:
      *
-     *		const source = new Collection();
-     *		const target = new Collection();
+     * ```ts
+     * const source = new Collection<{ hidden: boolean }>();
+     * const target = new Collection<{ hidden: boolean }>();
      *
-     *		target.bindTo( source ).using( item => {
-     *			if ( item.hidden ) {
-     *				return null;
-     *			}
+     * target.bindTo( source ).using( item => {
+     * 	if ( item.hidden ) {
+     * 		return null;
+     * 	}
      *
-     *			return item;
-     *		} );
+     * 	return item;
+     * } );
      *
-     *		source.add( { hidden: true } );
-     *		source.add( { hidden: false } );
+     * source.add( { hidden: true } );
+     * source.add( { hidden: false } );
      *
-     *		console.log( source.length ); // 2
-     *		console.log( target.length ); // 1
+     * console.log( source.length ); // 2
+     * console.log( target.length ); // 1
+     * ```
      *
      * **Note**: {@link #clear} can be used to break the binding.
      *
-     * @param {module:utils/collection~Collection} externalCollection A collection to be bound.
-     * @returns {module:utils/collection~CollectionBindToChain} The binding chain object.
+     * @typeParam S The type of `externalCollection` element.
+     * @param externalCollection A collection to be bound.
+     * @returns The binding chain object.
      */
     bindTo(externalCollection) {
         if (this._bindToCollection) {
@@ -410,16 +376,13 @@ export default class Collection extends Emitter {
         };
     }
     /**
-     * Finalizes and activates a binding initiated by {#bindTo}.
+     * Finalizes and activates a binding initiated by {@link #bindTo}.
      *
-     * @private
-     * @param {Function} factory A function which produces collection items.
+     * @param factory A function which produces collection items.
      */
     _setUpBindToBinding(factory) {
         const externalCollection = this._bindToCollection;
         // Adds the item to the collection once a change has been done to the external collection.
-        //
-        // @private
         const addItem = (evt, externalItem, index) => {
             const isExternalBoundToThis = externalCollection._bindToCollection == this;
             const externalItemBound = externalCollection._bindToInternalToExternalMap.get(externalItem);
@@ -523,9 +486,7 @@ export default class Collection extends Emitter {
      *
      * The method will generate new id and assign it to the `item` if it doesn't have any.
      *
-     * @private
-     * @param {Object} item Item to be added.
-     * @returns {String}
+     * @param item Item to be added.
      */
     _getItemIdBeforeAdding(item) {
         const idProperty = this._idProperty;
@@ -559,9 +520,8 @@ export default class Collection extends Emitter {
      *
      * In contrast this method **does not** fire the {@link #event:change} event.
      *
-     * @private
-     * @param {Object|Number|String} subject The item to remove, its id or index in the collection.
-     * @returns {Array} Returns an array with the removed item and its index.
+     * @param subject The item to remove, its id or index in the collection.
+     * @returns Returns an array with the removed item and its index.
      * @fires remove
      */
     _remove(subject) {
@@ -608,8 +568,6 @@ export default class Collection extends Emitter {
     }
     /**
      * Iterable interface.
-     *
-     * @returns {Iterator.<*>}
      */
     [Symbol.iterator]() {
         return this._items[Symbol.iterator]();

package/src/comparearrays.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
@@ -11,15 +11,17 @@
  * a flag specifying the relation is returned. Flags are negative numbers, so whenever a number >= 0 is returned
  * it means that arrays differ.
  *
- *		compareArrays( [ 0, 2 ], [ 0, 2 ] );		// 'same'
- *		compareArrays( [ 0, 2 ], [ 0, 2, 1 ] );		// 'prefix'
- *		compareArrays( [ 0, 2 ], [ 0 ] );			// 'extension'
- *		compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
- *		compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1
+ * ```ts
+ * compareArrays( [ 0, 2 ], [ 0, 2 ] );		// 'same'
+ * compareArrays( [ 0, 2 ], [ 0, 2, 1 ] );		// 'prefix'
+ * compareArrays( [ 0, 2 ], [ 0 ] );			// 'extension'
+ * compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
+ * compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1
+ * ```
  *
- * @param {Array} a Array that is compared.
- * @param {Array} b Array to compare with.
- * @returns {module:utils/comparearrays~ArrayRelation|Number} How array `a` is related to `b`.
+ * @param a Array that is compared.
+ * @param b Array to compare with.
+ * @returns How array `a` is related to `b`.
  */
 export default function compareArrays(a, b) {
     const minLen = Math.min(a.length, b.length);

package/src/config.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
@@ -8,21 +8,17 @@
 import { isPlainObject, isElement, cloneDeepWith } from 'lodash-es';
 /**
  * Handles a configuration dictionary.
+ *
+ * @typeParam Cfg A type of the configuration dictionary.
  */
 export default class Config {
     /**
      * Creates an instance of the {@link ~Config} class.
      *
-     * @param {Object} [configurations] The initial configurations to be set. Usually, provided by the user.
-     * @param {Object} [defaultConfigurations] The default configurations. Usually, provided by the system.
+     * @param configurations The initial configurations to be set. Usually, provided by the user.
+     * @param defaultConfigurations The default configurations. Usually, provided by the system.
      */
     constructor(configurations, defaultConfigurations) {
-        /**
-         * Store for the whole configuration.
-         *
-         * @private
-         * @member {Object}
-         */
         this._config = {};
         // Set default configuration.
         if (defaultConfigurations) {
@@ -35,57 +31,9 @@ export default class Config {
             this._setObjectToTarget(this._config, configurations);
         }
     }
-    /**
-     * Set configuration values.
-     *
-     * It accepts both a name/value pair or an object, which properties and values will be used to set
-     * configurations.
-     *
-     * It also accepts setting a "deep configuration" by using dots in the name. For example, `'resize.width'` sets
-     * the value for the `width` configuration in the `resize` subset.
-     *
-     *		config.set( 'width', 500 );
-     *		config.set( 'toolbar.collapsed', true );
-     *
-     *		// Equivalent to:
-     *		config.set( {
-     *			width: 500
-     *			toolbar: {
-     *				collapsed: true
-     *			}
-     *		} );
-     *
-     * Passing an object as the value will amend the configuration, not replace it.
-     *
-     *		config.set( 'toolbar', {
-     *			collapsed: true,
-     *		} );
-     *
-     *		config.set( 'toolbar', {
-     *			color: 'red',
-     *		} );
-     *
-     *		config.get( 'toolbar.collapsed' ); // true
-     *		config.get( 'toolbar.color' ); // 'red'
-     *
-     * @param {String|Object} name The configuration name or an object from which take properties as
-     * configuration entries. Configuration names are case-sensitive.
-     * @param {*} value The configuration value. Used if a name is passed.
-     */
     set(name, value) {
         this._setToTarget(this._config, name, value);
     }
-    /**
-     * Does exactly the same as {@link #set} with one exception – passed configuration extends
-     * existing one, but does not overwrite already defined values.
-     *
-     * This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
-     * rarely used for other needs.
-     *
-     * @param {String|Object} name The configuration name or an object from which take properties as
-     * configuration entries. Configuration names are case-sensitive.
-     * @param {*} value The configuration value. Used if a name is passed.
-     */
     define(name, value) {
         const isDefine = true;
         this._setToTarget(this._config, name, value, isDefine);
@@ -93,22 +41,24 @@ export default class Config {
     /**
      * Gets the value for a configuration entry.
      *
-     *		config.get( 'name' );
+     * ```ts
+     * config.get( 'name' );
+     * ```
      *
      * Deep configurations can be retrieved by separating each part with a dot.
      *
-     *		config.get( 'toolbar.collapsed' );
+     * ```ts
+     * config.get( 'toolbar.collapsed' );
+     * ```
      *
-     * @param {String} name The configuration name. Configuration names are case-sensitive.
-     * @returns {*} The configuration value or `undefined` if the configuration entry was not found.
+     * @param name The configuration name. Configuration names are case-sensitive.
+     * @returns The configuration value or `undefined` if the configuration entry was not found.
      */
     get(name) {
         return this._getFromSource(this._config, name);
     }
     /**
      * Iterates over all top level configuration names.
-     *
-     * @returns {Iterable.<String>}
      */
     *names() {
         for (const name of Object.keys(this._config)) {
@@ -118,12 +68,11 @@ export default class Config {
     /**
      * Saves passed configuration to the specified target (nested object).
      *
-     * @private
-     * @param {Object} target Nested config object.
-     * @param {String|Object} name The configuration name or an object from which take properties as
+     * @param target Nested config object.
+     * @param name The configuration name or an object from which take properties as
      * configuration entries. Configuration names are case-sensitive.
-     * @param {*} value The configuration value. Used if a name is passed.
-     * @param {Boolean} [isDefine=false] Define if passed configuration should overwrite existing one.
+     * @param value The configuration value. Used if a name is passed.
+     * @param isDefine Define if passed configuration should overwrite existing one.
      */
     _setToTarget(target, name, value, isDefine = false) {
         // In case of an object, iterate through it and call `_setToTarget` again for each property.
@@ -164,10 +113,9 @@ export default class Config {
     /**
      * Get specified configuration from specified source (nested object).
      *
-     * @private
-     * @param {Object} source level of nested object.
-     * @param {String} name The configuration name. Configuration names are case-sensitive.
-     * @returns {*} The configuration value or `undefined` if the configuration entry was not found.
+     * @param source level of nested object.
+     * @param name The configuration name. Configuration names are case-sensitive.
+     * @returns The configuration value or `undefined` if the configuration entry was not found.
      */
     _getFromSource(source, name) {
         // The configuration name should be split into parts if it has dots. E.g. `resize.width` -> [`resize`, `width`].
@@ -189,10 +137,9 @@ export default class Config {
     /**
      * Iterates through passed object and calls {@link #_setToTarget} method with object key and value for each property.
      *
-     * @private
-     * @param {Object} target Nested config object.
-     * @param {Object} configuration Configuration data set
-     * @param {Boolean} [isDefine] Defines if passed configuration is default configuration or not.
+     * @param target Nested config object.
+     * @param configuration Configuration data set
+     * @param isDefine Defines if passed configuration is default configuration or not.
      */
     _setObjectToTarget(target, configuration, isDefine) {
         Object.keys(configuration).forEach(key => {
@@ -200,17 +147,16 @@ export default class Config {
         });
     }
 }
-// Clones configuration object or value.
-// @param {*} source Source configuration
-// @returns {*} Cloned configuration value.
+/**
+ * Clones configuration object or value.
+ */
 function cloneConfig(source) {
     return cloneDeepWith(source, leaveDOMReferences);
 }
-// A customized function for cloneDeepWith.
-// It will leave references to DOM Elements instead of cloning them.
-//
-// @param {*} value
-// @returns {Element|undefined}
+/**
+ * A customized function for cloneDeepWith.
+ * It will leave references to DOM Elements instead of cloning them.
+ */
 function leaveDOMReferences(value) {
     return isElement(value) ? value : undefined;
 }

package/src/count.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
@@ -8,10 +8,12 @@
 /**
  * Returns the number of items return by the iterator.
  *
- *		count( [ 1, 2, 3, 4, 5 ] ); // 5;
+ * ```ts
+ * count( [ 1, 2, 3, 4, 5 ] ); // 5;
+ * ```
  *
- * @param {Iterable.<*>} iterable Any iterable.
- * @returns {Number} Number of items returned by that iterable.
+ * @param iterable Any iterable.
+ * @returns Number of items returned by that iterable.
  */
 export default function count(iterable) {
     let count = 0;