refactor: clarify array sample function documentation (antfu#30)

felixranesberger · web-flow · commit 110687261d08 · 2023-03-06T17:35:39.000+01:00
diff --git a/src/array.ts b/src/array.ts
@@ -180,12 +180,13 @@ export function clampArrayRange(n: number, arr: readonly unknown[]) {
 }
 
 /**
- * Get random items from an array
+ * Get random item(s) from an array
  *
- * @category Array
+ * @param arr
+ * @param quantity - quantity of random items which will be returned
  */
-export function sample<T>(arr: T[], count: number) {
-  return Array.from({ length: count }, _ => arr[Math.round(Math.random() * (arr.length - 1))])
+export function sample<T>(arr: T[], quantity: number) {
+  return Array.from({ length: quantity }, _ => arr[Math.round(Math.random() * (arr.length - 1))])
 }
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -180,12 +180,13 @@ export function clampArrayRange(n: number, arr: readonly unknown[]) {`
`180`	`180`	`}`
`181`	`181`
`182`	`182`	`/**`
`183`		`- * Get random items from an array`
	`183`	`+ * Get random item(s) from an array`
`184`	`184`	`*`
`185`		`- * @category Array`
	`185`	`+ * @param arr`
	`186`	`+ * @param quantity - quantity of random items which will be returned`
`186`	`187`	`*/`
`187`		`-export function sample<T>(arr: T[], count: number) {`
`188`		`- return Array.from({ length: count }, _ => arr[Math.round(Math.random() * (arr.length - 1))])`
	`188`	`+export function sample<T>(arr: T[], quantity: number) {`
	`189`	`+ return Array.from({ length: quantity }, _ => arr[Math.round(Math.random() * (arr.length - 1))])`
`189`	`190`	`}`
`190`	`191`
`191`	`192`	`/**`