fix: typefix for installPath param annotation (#96)

* fix: Add `installPath` parameter type annotation. * chore: update changelog file.
nvuillam · Feb 9, 2025 · 82a4df2 · 82a4df2
1 parent 753104a
commit 82a4df2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased] (beta, main branch content)
 
+## [v1.4.1] - 2025-02-06
+
+- fix: Add `installPath` parameter type annotation.
+
 ## [v1.4.0] - 2024-08-30
 
 - Allow to force an installation path for java using option `installPath`

diff --git a/lib/install.js b/lib/install.js
@@ -164,6 +164,7 @@ function followToAdoptium(location) {
  * @param {string} [options.type = jre] - Binary Type (`jre`/`jdk`)
  * @param {string} [options.heap_size] - Heap Size (`normal`/`large`)
  * @param {string} [options.vendor] - defaults to adoptopenjdk (`adoptopenjdk`/`eclipse`)
+ * @param {string} [options.installPath] - Where to install java (default process.cwd())
  * @return Promise<string> - Resolves to the installation directory or rejects an error
  * @example
  * const njre = require('njre')