[types] add a helpful hover description

inspect-js · Mar 10, 2024 · 29ccf8d · 29ccf8d
1 parent f42bec3
commit 29ccf8d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -1,3 +1,9 @@
+/**
+ * Determines the type of the given collection, or returns false.
+ *
+ * @param {unknown} value The potential collection
+ * @returns {TypedArrayName | false | null} 'Int8Array' | 'Uint8Array' | 'Uint8ClampedArray' | 'Int16Array' | 'Uint16Array' | 'Int32Array' | 'Uint32Array' | 'Float32Array' | 'Float64Array' | 'BigInt64Array' | 'BigUint64Array' | false | null
+ */
 declare function whichTypedArray(value: Int8Array): 'Int8Array';
 declare function whichTypedArray(value: Uint8Array): 'Uint8Array';
 declare function whichTypedArray(value: Uint8ClampedArray): 'Uint8ClampedArray';
@@ -52,4 +58,4 @@ declare namespace whichTypedArray {
     | BigUint64ArrayConstructor;
 }
 
-export = whichTypedArray;
+export = whichTypedArray;