JSDocs for types

Author: slowcheetah

packages/core-js-types/src/56/proposals/accessible-object-hasownproperty.d.ts

@@ -5,5 +5,10 @@
 // https://github.com/microsoft/TypeScript/blob/069de743dbd17b47cc2fc58e1d16da5410911284/src/lib/es2022.object.d.ts
 // License: https://github.com/microsoft/TypeScript/blob/v5.9.3/LICENSE.txt
 interface ObjectConstructor {
+  /**
+   * Determines whether an object has a property with the specified name.
+   * @param o An object.
+   * @param v A property name.
+   */
   hasOwn(o: object, v: PropertyKey): boolean;
 }

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

@@ -25,17 +25,51 @@ type processMetadata = {
 }
 
 interface Uint8ArrayConstructor {
-  fromBase64(str: string, opts?: fromBase64Options): Uint8Array;
+  /**
+   * Creates a new `Uint8Array` from a base64-encoded string.
+   * @param string The base64-encoded string.
+   * @param options If provided, specifies the alphabet and handling of the last chunk.
+   * @returns A new `Uint8Array` instance.
+   * @throws {SyntaxError} If the input string contains characters outside the specified alphabet, or if the last
+   * chunk is inconsistent with the `lastChunkHandling` option.
+   */
+  fromBase64(string: string, options?: fromBase64Options): Uint8Array;
 
+  /**
+   * Creates a new `Uint8Array` from a base16-encoded string.
+   * @returns A new `Uint8Array` instance.
+   */
   fromHex(str: string): Uint8Array;
 }
 
 interface Uint8Array {
-  setFromBase64(str: string, opts?: fromBase64Options): processMetadata;
+  /**
+   * Sets the `Uint8Array` from a base64-encoded string.
+   * @param string The base64-encoded string.
+   * @param options If provided, specifies the alphabet and handling of the last chunk.
+   * @returns An object containing the number of bytes read and written.
+   * @throws {SyntaxError} If the input string contains characters outside the specified alphabet, or if the last
+   * chunk is inconsistent with the `lastChunkHandling` option.
+   */
+  setFromBase64(string: string, options?: fromBase64Options): processMetadata;
 
-  setFromHex(str: string): processMetadata;
+  /**
+   * Sets the `Uint8Array` from a base16-encoded string.
+   * @param string The base16-encoded string.
+   * @returns An object containing the number of bytes read and written.
+   */
+  setFromHex(string: string): processMetadata;
 
-  toBase64(opts?: toBase64Options): string;
+  /**
+   * Converts the `Uint8Array` to a base64-encoded string.
+   * @param options If provided, sets the alphabet and padding behavior used.
+   * @returns A base64-encoded string.
+   */
+  toBase64(options?: toBase64Options): string;
 
+  /**
+   * Converts the `Uint8Array` to a base16-encoded string.
+   * @returns A base16-encoded string.
+   */
   toHex(): string;
 }

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

@@ -1,11 +1,28 @@
 // proposal stage: 4
 // https://github.com/tc39/proposal-arraybuffer-transfer
 
+// For ensuring compatibility with TypeScript standard types, this code is based on:
+// https://github.com/microsoft/TypeScript/blob/4a957b74ea4d716356181644d23f6ad5f10824d6/src/lib/es2024.arraybuffer.d.ts
+// License: https://github.com/microsoft/TypeScript/blob/v5.9.3/LICENSE.txt
+
 interface ArrayBuffer {
   // todo hack for modern ts
   // get detached(): boolean;
 
+  /**
+   * 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
+   * @returns A new `ArrayBuffer` object
+   */
   transfer(newByteLength?: number): ArrayBuffer;
 
+  /**
+   * 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
+   * @returns A new `ArrayBuffer` object
+   */
   transferToFixedLength(newByteLength?: number): ArrayBuffer;
 }

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

@@ -2,38 +2,101 @@
 // https://github.com/tc39/proposal-array-filtering
 
 interface Array<T> {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: T, index: number, target: T[]) => boolean, thisArg?: any): T[];
 }
 
 interface Int8Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Int8Array) => boolean, thisArg?: any): Int8Array;
 }
 
 interface Uint8Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Uint8Array) => boolean, thisArg?: any): Uint8Array;
 }
 
 interface Uint8ClampedArray {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Uint8ClampedArray) => boolean, thisArg?: any): Uint8ClampedArray;
 }
 
 interface Int16Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Int16Array) => boolean, thisArg?: any): Int16Array;
 }
 
 interface Uint16Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Uint16Array) => boolean, thisArg?: any): Uint16Array;
 }
 
 interface Int32Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Int32Array) => boolean, thisArg?: any): Int32Array;
 }
 
 interface Uint32Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Uint32Array) => boolean, thisArg?: any): Uint32Array;
 }
 
 interface Float32Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: number, index: number, target: Float32Array) => boolean, thisArg?: any): Float32Array;
 }
 
@@ -42,9 +105,23 @@ interface Float64Array {
 }
 
 interface BigInt64Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: bigint, index: number, target: BigInt64Array) => boolean, thisArg?: any): BigInt64Array;
 }
 
 interface BigUint64Array {
+  /**
+   * Removes the items that return true
+   * @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.
+   */
   filterReject(callbackFn: (value: bigint, index: number, target: BigUint64Array) => boolean, thisArg?: any): BigUint64Array;
 }