Types linting: TSDocs

Author: slowcheetah

packages/core-js-types/src/base/annex-b/object-proto.d.ts

@@ -1,7 +1,7 @@
 interface Object {
   /**
    * Accessor to [[Prototype]].
-   * This is non-standard and deprecated; prefer { Object, Reflect }.{ getPrototypeOf, setPrototypeOf }
+   * This is non-standard and deprecated; prefer `{ Object, Reflect }.{ getPrototypeOf, setPrototypeOf }`
    */
   __proto__: object | null;
 }

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

@@ -7,8 +7,8 @@
 interface ObjectConstructor {
   /**
    * Determines whether an object has a property with the specified name.
-   * @param o An object.
-   * @param v A property name.
+   * @param o - An object.
+   * @param v - A property name.
    */
   hasOwn(o: object, v: PropertyKey): boolean;
 }

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

@@ -26,10 +26,10 @@ interface processMetadata {
 interface Uint8ArrayConstructor {
   /**
    * 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.
+   * @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
+   * @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;
@@ -44,24 +44,24 @@ interface Uint8ArrayConstructor {
 interface Uint8Array {
   /**
    * 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.
+   * @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
+   * @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;
 
   /**
    * Sets the `Uint8Array` from a base16-encoded string.
-   * @param string The base16-encoded string.
+   * @param string - The base16-encoded string.
    * @returns An object containing the number of bytes read and written.
    */
   setFromHex(string: string): processMetadata;
 
   /**
    * Converts the `Uint8Array` to a base64-encoded string.
-   * @param options If provided, sets the alphabet and padding behavior used.
+   * @param options - If provided, sets the alphabet and padding behavior used.
    * @returns A base64-encoded string.
    */
   toBase64(options?: toBase64Options): string;

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

@@ -10,17 +10,17 @@ interface ArrayBuffer {
 
   /**
    * 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
+   * @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
+   * @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/base/proposals/array-filtering.d.ts

@@ -3,9 +3,9 @@
 interface Array<T> { // @type-options no-redefine
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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[];
@@ -14,9 +14,9 @@ interface Array<T> { // @type-options no-redefine
 interface ReadonlyArray<T> { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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[];
@@ -25,9 +25,9 @@ interface ReadonlyArray<T> { // @type-options no-export
 interface Int8Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -36,9 +36,9 @@ interface Int8Array { // @type-options no-export
 interface Uint8Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -47,9 +47,9 @@ interface Uint8Array { // @type-options no-export
 interface Uint8ClampedArray { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -58,9 +58,9 @@ interface Uint8ClampedArray { // @type-options no-export
 interface Int16Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -69,9 +69,9 @@ interface Int16Array { // @type-options no-export
 interface Uint16Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -80,9 +80,9 @@ interface Uint16Array { // @type-options no-export
 interface Int32Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -91,9 +91,9 @@ interface Int32Array { // @type-options no-export
 interface Uint32Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -102,9 +102,9 @@ interface Uint32Array { // @type-options no-export
 interface Float32Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -113,9 +113,9 @@ interface Float32Array { // @type-options no-export
 interface Float64Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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: Float64Array) => boolean, thisArg?: any): Float64Array;
@@ -124,9 +124,9 @@ interface Float64Array { // @type-options no-export
 interface BigInt64Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;
@@ -135,9 +135,9 @@ interface BigInt64Array { // @type-options no-export
 interface BigUint64Array { // @type-options no-export
   /**
    * Removes the items that return true
-   * @param callbackFn A function that accepts up to three arguments. The filterReject method calls the
+   * @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
+   * @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;