Merge branch 'getversion-types' into master

bubenshchykov · Sep 10, 2020 · b61ebcf · b61ebcf
2 parents ec32217 + 5fd109b
commit b61ebcf
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/ngrok.d.ts b/ngrok.d.ts
@@ -54,6 +54,12 @@ export function getApi(): RequestAPI<Request, CoreOptions, RequiredUriUrl> | nul
  */
 export function authtoken(token: string | INgrokOptions): Promise<void>;
 
+/**
+ *
+ * Gets the version of the ngrok binary.
+ */
+export function getVersion(options?: INgrokOptions): Promise<string>;
+
 interface INgrokOptions {
     /**
      * Other "custom", indirectly-supported ngrok process options.

diff --git a/process.js b/process.js
@@ -129,6 +129,9 @@ async function setAuthtoken (optsOrToken) {
 	}
 }
 
+/**
+ * @param {INgrokOptions | undefined} opts
+ */
 async function getVersion(opts = {}) {
 	let dir = defaultDir;
 	if (opts.binPath) dir = opts.binPath(dir);