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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
# TypeScript usage examples
The TypeScript definitions take into account yargs' `type` key and the prescense of
`demandOption`/`default`.
The following `.options()` definition:
```typescript
#!/usr/bin/env node
import yargs = require('yargs/yargs');
const argv = yargs(process.argv.slice(2)).options({
a: { type: 'boolean', default: false },
b: { type: 'string', demandOption: true },
c: { type: 'number', alias: 'chill' },
d: { type: 'array' },
e: { type: 'count' },
f: { choices: ['1', '2', '3'] }
}).argv;
```
Will result in an `argv` that's typed like so:
```typescript
{
[x: string]: unknown;
a: boolean;
b: string;
c: number | undefined;
d: (string | number)[] | undefined;
e: number;
f: string | undefined;
_: string[];
$0: string;
}
```
You will likely want to define an interface for your application, describing the form that
the parsed `argv` will take:
```typescript
interface Arguments {
[x: string]: unknown;
a: boolean;
b: string;
c: number | undefined;
d: (string | number)[] | undefined;
e: number;
f: string | undefined;
}
```
To improve the `choices` option typing you can also specify its types:
```typescript
type Difficulty = 'normal' | 'nightmare' | 'hell';
const difficulties: ReadonlyArray<Difficulty> = ['normal', 'nightmare', 'hell'];
const argv = yargs.option('difficulty', {
choices: difficulties,
demandOption: true
}).argv;
```
`argv` will get type `'normal' | 'nightmare' | 'hell'`.
|
