fix some jsdoc and param names

Author: zloirock

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

@@ -36,9 +36,10 @@ interface Uint8ArrayConstructor {
 
   /**
    * Creates a new `Uint8Array` from a base16-encoded string.
+   * @param string - The base16-encoded string.
    * @returns A new `Uint8Array` instance.
    */
-  fromHex(str: string): Uint8Array;
+  fromHex(string: string): Uint8Array;
 }
 
 interface Uint8Array {

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

@@ -94,7 +94,7 @@ interface Uint32Array { // @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: Uint32Array) => unknown, thisArg?: any): Uint32Array;
 }

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

@@ -25,7 +25,7 @@ interface Int8Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Int8Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Int8Array;
 }
@@ -35,7 +35,7 @@ interface Uint8Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Uint8Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Uint8Array;
 }
@@ -45,7 +45,7 @@ interface Uint8ClampedArray { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Uint8ClampedArray` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Uint8ClampedArray;
 }
@@ -55,7 +55,7 @@ interface Int16Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Int16Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Int16Array;
 }
@@ -65,7 +65,7 @@ interface Uint16Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Uint16Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Uint16Array;
 }
@@ -75,7 +75,7 @@ interface Int32Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Int32Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Int32Array;
 }
@@ -85,7 +85,7 @@ interface Uint32Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Uint32Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Uint32Array;
 }
@@ -95,7 +95,7 @@ interface Float32Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Float32Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Float32Array;
 }
@@ -105,7 +105,7 @@ interface Float64Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `Float64Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: number) => unknown)): Float64Array;
 }
@@ -115,7 +115,7 @@ interface BigInt64Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `BigInt64Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: bigint) => unknown)): BigInt64Array;
 }
@@ -125,7 +125,7 @@ interface BigUint64Array { // @type-options: no-export
    * Returns a new array with unique items, determined by the resolver function or property key
    * @param resolver - A function that resolves the value to check uniqueness against,
    * or a property key to compare the value from each item
-   * @returns A new `Array` with unique items
+   * @returns A new `BigUint64Array` with unique items
    */
   uniqueBy(resolver?: PropertyKey | ((value: bigint) => unknown)): BigUint64Array;
 }

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

@@ -24,7 +24,7 @@ interface AsyncIterator<T, TReturn = any, TNext = any> {
   /**
    * Check if every value generated by the iterator passes the `predicate` function.
    * @param predicate - A function that tests each element of the iterator
-   * @returns A promise that resolves to `true` if all elements pass the test, otherwise `false`
+   * @returns A `Promise` that resolves to `true` if all elements pass the test, otherwise `false`
    */
   every(predicate: (value: T, index: number) => unknown): Promise<boolean>;
 
@@ -68,25 +68,25 @@ interface AsyncIterator<T, TReturn = any, TNext = any> {
   /**
    * Reduces the elements of the iterator to a single value using the `callbackfn` function.
    * @param callbackfn - A function that combines two elements of the iterator
-   * @returns A promise that resolves to the reduced value
+   * @returns A `Promise` that resolves to the reduced value
    */
   reduce(callbackfn: (accumulator: T, value: T, index: number) => T): Promise<T>;
 
   /**
-   * Reduces the elements of the iterator to a single value using the `reducer` function.
-   * @param reducer - A function that combines two elements of the iterator
+   * Reduces the elements of the iterator to a single value using the `callbackfn` function.
+   * @param callbackfn - A function that combines two elements of the iterator
    * @param initialValue - The initial value to start the reduction
-   * @returns A promise that resolves to the reduced value
+   * @returns A `Promise` that resolves to the reduced value
    */
-  reduce(reducer: (accumulator: T, value: T, index: number) => T, initialValue: T): Promise<T>;
+  reduce(callbackfn: (accumulator: T, value: T, index: number) => T, initialValue: T): Promise<T>;
 
   /**
-   * Reduces the elements of the iterator to a single value using the `reducer` function.
-   * @param reducer - A function that combines two elements of the iterator
+   * Reduces the elements of the iterator to a single value using the `callbackfn` function.
+   * @param callbackfn - A function that combines two elements of the iterator
    * @param initialValue - The initial value to start the accumulation. Required when the accumulator type differs from the element type.
    * @returns A `Promise` that resolves to the reduced value
    */
-  reduce<U>(reducer: (accumulator: U, value: T, index: number) => U, initialValue: U): Promise<U>;
+  reduce<U>(callbackfn: (accumulator: U, value: T, index: number) => U, initialValue: U): Promise<U>;
 
   /**
    * Checks if any value in the iterator matches a given `predicate`

packages/core-js-types/src/base/proposals/await-dictionary.d.ts

@@ -15,7 +15,7 @@ interface PromiseConstructor {
    * Takes an object whose values are promises and returns a single `Promise` that resolves
    * to an object with the same keys, after all of the input promises have settled.
    * @param promises - An object of promises
-   * @returns A new Promise that resolves to an object with the same keys as the input object,
+   * @returns A new `Promise` that resolves to an object with the same keys as the input object,
    * where each key maps to the settlement result (`{ status, value }` or `{ status, reason }`) of the corresponding promise.
    */
   allSettledKeyed<D extends Record<PropertyKey, unknown>>(promises: D): Promise<{ [k in keyof D]: CoreJS.CoreJSPromiseSettledResult<Awaited<D[k]>> }>;

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

@@ -58,7 +58,7 @@ declare namespace CoreJS {
      * Takes an object whose values are promises and returns a single `Promise` that resolves
      * to an object with the same keys, after all of the input promises have settled.
      * @param promises - An object of promises
-     * @returns A new Promise that resolves to an object with the same keys as the input object,
+     * @returns A new `Promise` that resolves to an object with the same keys as the input object,
      * where each key maps to the settlement result (`{ status, value }` or `{ status, reason }`) of the corresponding promise.
      */
     allSettledKeyed<D extends Record<PropertyKey, unknown>>(promises: D): CoreJSPromise<{ [k in keyof D]: CoreJS.CoreJSPromiseSettledResult<Awaited<D[k]>> }>;

packages/core-js-types/src/base/pure/proposals/array-buffer-transfer.d.ts

@@ -14,16 +14,16 @@ declare namespace CoreJS {
     /**
      * Creates a new `ArrayBuffer` with the same byte content as this buffer, then detaches this buffer.
      * @param newByteLength - If provided, specifies the `byteLength` of the new `ArrayBuffer`
-     * @throws `RangeError` If this `ArrayBuffer` is resizable and newByteLength is greater than the `maxByteLength` of this `ArrayBuffer`
-     * @throws `TypeError` If this `ArrayBuffer` is already detached, or if it can only be detached by designated operations
+     * @throws RangeError If this `ArrayBuffer` is resizable and newByteLength is greater than the `maxByteLength` of this `ArrayBuffer`
+     * @throws TypeError If this `ArrayBuffer` is already detached, or if it can only be detached by designated operations
      * @returns A new `ArrayBuffer` object
      */
     transfer(newByteLength?: number): CoreJSArrayBuffer;
 
     /**
      * Creates a new non-resizable `ArrayBuffer` with the same byte content as this buffer, then detaches this buffer.
      * @param newByteLength - If provided, specifies the `byteLength` of the new `ArrayBuffer`
-     * @throws `TypeError` If this `ArrayBuffer` is already detached, or if it can only be detached by designated operations
+     * @throws TypeError If this `ArrayBuffer` is already detached, or if it can only be detached by designated operations
      * @returns A new `ArrayBuffer` object
      */
     transferToFixedLength(newByteLength?: number): CoreJSArrayBuffer;

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

@@ -32,7 +32,7 @@ declare namespace CoreJS {
     fromAsync<T, U>(iterableOrArrayLike: CoreJSAsyncIterable<T> | Iterable<T> | ArrayLike<T>, mapFn: (value: Awaited<T>, index: number) => U, thisArg?: any): CoreJSPromise<Awaited<U>[]>;
 
     /**
-     * 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/pure/proposals/async-iterator-helpers.d.ts

@@ -28,7 +28,7 @@ declare namespace CoreJS {
     /**
      * Check if every value generated by the iterator passes the `predicate` function.
      * @param predicate - A function that tests each element of the iterator
-     * @returns A promise that resolves to `true` if all elements pass the test, otherwise `false`
+     * @returns A `Promise` that resolves to `true` if all elements pass the test, otherwise `false`
      */
     every(predicate: (value: T, index: number) => unknown): CoreJSPromise<boolean>;
 

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

@@ -155,6 +155,10 @@ declare namespace CoreJS {
     find<S extends T>(predicate: (value: T, index: number) => value is S): S | undefined;
     find(predicate: (value: T, index: number) => unknown): T | undefined;
 
+    /**
+     * Creates a string by concatenating all elements provided by the iterator, separated by the specified separator.
+     * @param separator - A string to separate each element. If omitted, the elements are separated by commas.
+     */
     join(separator?: unknown): string;
   }
 
@@ -172,14 +176,14 @@ declare namespace CoreJS {
      * @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): CoreJSIteratorObject<{ [K in keyof T]: T[K] extends Iterable<infer V> ? V : never }, undefined, unknown>;
     zip<T>(iterables: Iterable<Iterable<T, unknown, undefined>>, options?: ZipOptions): CoreJSIteratorObject<T[], undefined, unknown>;
 
     /**
-     * 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: