docs(collections): add module example (#4475)

docs(collections): add module docs
denoland · Mar 12, 2024 · 48d7fd5 · 48d7fd5
1 parent 57605ec
commit 48d7fd5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/collections/_utils.ts b/collections/_utils.ts
@@ -28,6 +28,6 @@ export function filterInPlace<T>(
 /**
  * Produces a random number between the inclusive `lower` and `upper` bounds.
  */
-export function randomInteger(lower: number, upper: number) {
+export function randomInteger(lower: number, upper: number): number {
   return lower + Math.floor(Math.random() * (upper - lower + 1));
 }
diff --git a/collections/mod.ts b/collections/mod.ts
@@ -9,6 +9,14 @@
  * {@link https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/ | Kotlin's Collections}
  * package.
  *
+ * ```ts
+ * import { intersect } from "https://deno.land/std@$STD_VERSION/collections/intersect.ts";
+ *
+ * const lisaInterests = ["Cooking", "Music", "Hiking"];
+ * const kimInterests = ["Music", "Tennis", "Cooking"];
+ * intersect(lisaInterests, kimInterests); // [ "Cooking", "Music" ]
+ * ```
+ *
  * @module
  */