TSDocs fixes

Author: slowcheetah

packages/core-js-types/src/base/proposals/array-filtering.d.ts

@@ -6,7 +6,7 @@ interface Array<T> { // @type-options: no-redefine
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: T, index: number, target: T[]) => unknown, thisArg?: any): T[];
 }
@@ -17,7 +17,7 @@ interface ReadonlyArray<T> { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: T, index: number, target: readonly T[]) => unknown, thisArg?: any): T[];
 }
@@ -28,7 +28,7 @@ interface Int8Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Int8Array) => unknown, thisArg?: any): Int8Array;
 }
@@ -39,7 +39,7 @@ interface Uint8Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Uint8Array) => unknown, thisArg?: any): Uint8Array;
 }
@@ -50,7 +50,7 @@ interface Uint8ClampedArray { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Uint8ClampedArray) => unknown, thisArg?: any): Uint8ClampedArray;
 }
@@ -61,7 +61,7 @@ interface Int16Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Int16Array) => unknown, thisArg?: any): Int16Array;
 }
@@ -72,7 +72,7 @@ interface Uint16Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Uint16Array) => unknown, thisArg?: any): Uint16Array;
 }
@@ -83,7 +83,7 @@ interface Int32Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Int32Array) => unknown, thisArg?: any): Int32Array;
 }
@@ -105,7 +105,7 @@ interface Float32Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Float32Array) => unknown, thisArg?: any): Float32Array;
 }
@@ -116,7 +116,7 @@ interface Float64Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: number, index: number, target: Float64Array) => unknown, thisArg?: any): Float64Array;
 }
@@ -127,7 +127,7 @@ interface BigInt64Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: bigint, index: number, target: BigInt64Array) => unknown, thisArg?: any): BigInt64Array;
 }
@@ -138,7 +138,7 @@ interface BigUint64Array { // @type-options: no-export
    * @param callbackFn - A function that accepts up to three arguments. The filterReject method calls the
    * callbackFn function one time for each element in the array.
    * @param thisArg - If provided, it will be used as this value for each invocation of
-   * predicate. If it is not provided, undefined is used instead.
+   * callbackFn function. If it is not provided, undefined is used instead.
    */
   filterReject(callbackFn: (value: bigint, index: number, target: BigUint64Array) => unknown, thisArg?: any): BigUint64Array;
 }

packages/core-js-types/src/base/proposals/array-is-template-object.d.ts

@@ -2,7 +2,7 @@
 
 interface ArrayConstructor { // @type-options: no-export
   /**
-   * Determines whether an `value` is a `TemplateStringsArray`
+   * Determines whether a `value` is a `TemplateStringsArray`
    * @param value - The value to be checked
    * @returns `true` if `value` is a `TemplateStringsArray`, otherwise `false`
    */

packages/core-js-types/src/base/proposals/iterator-helpers.d.ts

@@ -101,7 +101,7 @@ interface IteratorConstructor { // @type-options: no-extends
   /**
    * Creates a native iterator from an iterator or iterable object.
    * Returns its input if the input already inherits from the built-in Iterator class.
-   * @param value - An iterator or iterable object to convert a native iterator.
+   * @param value - An iterator or iterable object to convert to a native iterator.
    */
   from<T>(value: Iterator<T, unknown, undefined> | Iterable<T, unknown, undefined>): IteratorObject<T, undefined, unknown>;
 }

packages/core-js-types/src/base/proposals/iterator-joint.d.ts

@@ -19,14 +19,14 @@ interface IteratorConstructor { // @type-options: no-extends
    * @param iterables - An Iterable of iterables.
    * @param options - Optional object:
    *  - mode: 'shortest' (default) to stop at the shortest iterable | 'longest' to stop at the longest iterable | 'strict' to throw if iterables are not the same length;
-   *  - padding: an object specifying padding values for each key when mode is 'longest'.
-   * @returns An iterator yielding objects with keys from the input iterables and values from the corresponding iterables.
+   *  - padding: an iterable specifying padding values for each position when mode is 'longest'.
+   * @returns An iterator yielding arrays of values, collected one from each iterable.
    */
   zip<T extends readonly Iterable<unknown>[]>(iterables: T, options?: ZipOptions): IteratorObject<{ [K in keyof T]: T[K] extends Iterable<infer V> ? V : never }, undefined, unknown>; // @type-options: prefix-return-type
   zip<T>(iterables: Iterable<Iterable<T>>, options?: ZipOptions): IteratorObject<T[], undefined, unknown>; // @type-options: prefix-return-type
 
   /**
-   * takes an object whose values are iterables and produces an iterable of objects where keys.
+   * Takes an object whose values are iterables and produces an iterable of objects where keys
    * correspond to keys in the passed object.
    * @param record - An object of iterables.
    * @param options - Optional object:

packages/core-js-types/src/base/proposals/map-upsert.d.ts

@@ -8,13 +8,17 @@ interface Map<K, V> { // @type-options: no-redefine
   /**
    * Returns a specified element from the Map object.
    * If no element is associated with the specified key, a new element with the value `defaultValue` will be inserted into the Map and returned.
+   * @param key - The key of the element to return.
+   * @param defaultValue - The value to insert if the key is not already associated with an element.
    * @returns The element associated with the specified key, which will be `defaultValue` if no element previously existed.
    */
   getOrInsert(key: K, defaultValue: V): V;
   /**
    * Returns a specified element from the Map object.
    * If no element is associated with the specified key, the result of passing the specified key to the `callback` function will be inserted into the Map and returned.
-   * @returns The element associated with the specific key, which will be the newly computed value if no element previously existed.
+   * @param key - The key of the element to return.
+   * @param callback - A function that computes the value to insert if the key is not already associated with an element. It will be passed the key as an argument.
+   * @returns The element associated with the specified key, which will be the newly computed value if no element previously existed.
    */
   getOrInsertComputed(key: K, callback: (key: K) => V): V;
 }
@@ -23,13 +27,17 @@ interface WeakMap<K extends WeakKey, V> { // @type-options: no-redefine
   /**
    * Returns a specified element from the WeakMap object.
    * If no element is associated with the specified key, a new element with the value `defaultValue` will be inserted into the WeakMap and returned.
+   * @param key - The key of the element to return.
+   * @param defaultValue - The value to insert if the key is not already associated with an element.
    * @returns The element associated with the specified key, which will be `defaultValue` if no element previously existed.
    */
   getOrInsert(key: K, defaultValue: V): V;
   /**
    * Returns a specified element from the WeakMap object.
    * If no element is associated with the specified key, the result of passing the specified key to the `callback` function will be inserted into the WeakMap and returned.
-   * @returns The element associated with the specific key, which will be the newly computed value if no element previously existed.
+   * @param key - The key of the element to return.
+   * @param callback - A function that computes the value to insert if the key is not already associated with an element. It will be passed the key as an argument.
+   * @returns The element associated with the specified key, which will be the newly computed value if no element previously existed.
    */
   getOrInsertComputed(key: K, callback: (key: K) => V): V;
 }

packages/core-js-types/src/base/pure/proposals/iterator.d.ts

@@ -162,7 +162,7 @@ declare namespace CoreJS {
     /**
      * Creates a native iterator from an iterator or iterable object.
      * Returns its input if the input already inherits from the built-in Iterator class.
-     * @param value - An iterator or iterable object to convert a native iterator.
+     * @param value - An iterator or iterable object to convert to a native iterator.
      */
     from<T>(value: Iterator<T, unknown, undefined> | Iterable<T, unknown, undefined>): CoreJSIteratorObject<T, undefined, unknown>;
 

packages/core-js-types/src/ts5-2/pure/proposals/iterator.d.ts

@@ -168,7 +168,7 @@ declare namespace CoreJS {
     /**
      * Creates a native iterator from an iterator or iterable object.
      * Returns its input if the input already inherits from the built-in Iterator class.
-     * @param value - An iterator or iterable object to convert a native iterator.
+     * @param value - An iterator or iterable object to convert to a native iterator.
      */
     from<T>(value: Iterator<T, unknown, undefined> | Iterable<T>): CoreJSIteratorObject<T, undefined, unknown>;