docs: add jsdocs for detectPackageManager

unjs · Feb 6, 2024 · a7dfce7 · a7dfce7
1 parent d44ca3a
commit a7dfce7
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/package-manager.ts b/src/package-manager.ts
@@ -55,6 +55,13 @@ export const packageManagers: PackageManager[] = [
   },
 ] as const;
 
+/**
+ * Detect the package manager used in a directory (and up) by checking various sources:
+ *
+ * 1. Use `packageManager` field from package.json
+ *
+ * 2. Known lock files and other files
+ */
 export async function detectPackageManager(
   cwd: string,
   options: DetectPackageManagerOptions = {},