fix: patch js-api openProject() (#5000)

Co-authored-by: Emanuele Stoppa <[email protected]>
biomejs · Feb 10, 2025 · 4de5de8 · 4de5de8
1 parent 8379a60
commit 4de5de8
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 || "",