Add a signal option

Author: ehmicky

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 4.1.0
+
+## Features
+
+- Add a [`signal` option](README.md#signal) to cancel
+
 # 4.0.0
 
 ## Breaking changes

README.md

@@ -141,6 +141,13 @@ The list of available Node.js versions is cached for one hour by default. If the
 - `true`: the cache will not be used
 - `false`: the cache will be used even if it's older than one hour
 
+#### signal
+
+_Type_:
+[`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
+
+Cancels when the signal is aborted.
+
 # See also
 
 - [`nve`](https://github.com/ehmicky/nve): Run a specific Node.js version (CLI)

src/main.d.ts

@@ -33,6 +33,11 @@ export interface Options {
    */
   mirror?: NodeVersionAliasOptions['mirror']
 
+  /**
+   * Cancels when the signal is aborted.
+   */
+  signal?: NodeVersionAliasOptions['signal']
+
   /**
    * The list of available Node.js versions is cached for one hour by default.
    * If the `fetch` option is:

src/main.test-d.ts

@@ -31,6 +31,11 @@ expectAssignable<Options>({ mirror: 'https://example.com' })
 // @ts-expect-error
 await preferredNodeVersion({ mirror: true })
 
+await preferredNodeVersion({ signal: AbortSignal.abort() })
+expectAssignable<Options>({ signal: AbortSignal.abort() })
+// @ts-expect-error
+await preferredNodeVersion({ signal: 'signal' })
+
 await preferredNodeVersion({ fetch: true })
 await preferredNodeVersion({ fetch: undefined })
 expectAssignable<Options>({ fetch: true })

src/options.js

@@ -9,9 +9,15 @@ export const getOpts = (opts = {}) => {
     throw new TypeError(`Options must be a plain object: ${opts}`)
   }
 
-  const { cwd = '.', global: globalOpt = false, fetch: fetchOpt, mirror } = opts
+  const {
+    cwd = '.',
+    global: globalOpt = false,
+    fetch: fetchOpt,
+    mirror,
+    signal,
+  } = opts
   const cwdA = normalizeCwd(cwd)
-  const nodeVersionAliasOpts = { fetch: fetchOpt, mirror }
+  const nodeVersionAliasOpts = { fetch: fetchOpt, mirror, signal }
   return { cwd: cwdA, globalOpt, nodeVersionAliasOpts }
 }