Skip to content

Commit 3b03169

Browse files
docs: update info
1 parent 120e649 commit 3b03169

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88
$ npm install --save-dev cli-prompts-test
99
```
1010

11+
## API
12+
13+
### runTest(args, answers, options?)
14+
15+
- `args`: CLI args to pass in.
16+
- `answers`: answers to be passed to `stdout` (simulate user input).
17+
- `options`: Optionally specify the `testPath` (defaults to `process.cwd()`) and `timeout` (defaults to `500ms`) between keystrokes.
18+
1119
## Usage
1220

1321
```js
@@ -64,4 +72,6 @@ describe("cli-prompts-test", () => {
6472
expect(stdout).toContain("You chose Third option");
6573
});
6674
});
67-
```
75+
```
76+
77+
Find an example [here](https://github.com/madlabsinc/mevn-cli/blob/develop/jest/helpers.js).

0 commit comments

Comments
 (0)