-
-
Notifications
You must be signed in to change notification settings - Fork 11
/
index.d.ts
36 lines (27 loc) · 946 Bytes
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
export type Options = {
/**
The arguments to pass to `binary` so that it will print its version.
If not specified, predefined arguments will be used for known binaries, or `['--version']` and `['version']` arguments will be tried.
*/
readonly args?: readonly string[];
};
/**
Get the version of a binary in [semver](https://github.com/npm/node-semver) format.
@param binary - The name of or path to the binary to get the version from.
@returns The version of the `binary`.
@example
```
import binaryVersion from 'binary-version';
// $ curl --version
// curl 7.30.0 (x86_64-apple-darwin13.0)
console.log(await binaryVersion('curl'));
//=> '7.30.0'
// $ openssl version
// OpenSSL 1.0.2d 9 Jul 2015
console.log(await binaryVersion('openssl'));
//=> '1.0.2'
console.log(await binaryVersion('openssl', {args: ['version']}));
//=> '1.0.2'
```
*/
export default function binaryVersion(binary: string, options?: Options): Promise<string>;