From 82a4df2774a5a2e9a9d90387ec65083d7b9aa9cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BD=86=E4=B8=BA=E5=90=9B=E6=95=85?= Date: Sun, 9 Feb 2025 10:59:31 +0800 Subject: [PATCH] fix: typefix for `installPath` param annotation (#96) * fix: Add `installPath` parameter type annotation. * chore: update changelog file. --- CHANGELOG.md | 4 ++++ lib/install.js | 1 + 2 files changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2437b27..74c7bf8 100644 --- 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 index 1b33139..a66f1a4 100644 --- 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 - Resolves to the installation directory or rejects an error * @example * const njre = require('njre')