fix: patch @biomejs/js-api

biomejs · Feb 10, 2025 · 6473d15 · 6473d15
1 parent 8379a60
commit 6473d15
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.changeset/spotty-hounds-tie.md b/.changeset/spotty-hounds-tie.md
@@ -0,0 +1,5 @@
+---
+"@biomejs/js-api": patch
+---
+
+remove wrong openProject() definition, and add jsDoc.
diff --git a/packages/@biomejs/js-api/src/index.ts b/packages/@biomejs/js-api/src/index.ts
@@ -138,7 +138,11 @@ export class Biome {
 		}
 	}
 
-	openProject(): ProjectKey;
+	/**
+	 * Open a possible workspace project folder. Returns the key of said project. Use this key when you want to switch to different projects.
+	 *
+	 * @param {string} [path]
+	 */
 	openProject(path?: string): ProjectKey {
 		return this.workspace.openProject({
 			path: path || "",