Readonly dirWait until your CLI's stdout and stderr have been quiet for N seconds.
A promise that will resolve true if the CLI becomes idle for the desired time, or will throw an error on timeout.
The desired number of seconds of idle time.
Optional: Max time to wait for your CLI to become idle (ms).
Wait until a line of stderr matches your search string exactly.
a promise that will resolve true if a match is found, or will throw an error on timeout..
The string you'd like stderr to match exactly. *
Optional: Test includes output since last call to test.
Optional: Max time to wait for a match (ms).
Wait until a line of stderr includes the search string (using javascript string.includes)
See untilStdoutIncludes for example usage.
a promise that will resolve true if a match is found, or will throw an error on timeout.
The string you'd like the output to include. *
Optional: Test includes output since last call to test.
Optional: Max time to wait for a match (ms).
Wait until a line of your CLI's stderr passes your supplied matching function.
See untilStdoutPasses for example isage.
a promise that will resolve true if your test is passed, or will throw an error on timeout.
This is required to enable calling your test multiple times throughout the course of a test.
This will be printed in CliFry's log and should be short but descriptive, so that you can see clearly when your function passed or failed.
Optional: Test includes output since last call to test.
Optional: Max time to wait for a match (ms).
Wait until a line of stdout matches your search string exactly.
a promise that will resolve true if a match is found, or will throw an error on timeout.
The string you'd like stdout to match exactly. *
Optional: Test includes output since last call to test.
Optional: Max time to wait for a match (ms).
Wait until a line of stdout includes the search string (using javascript string.includes).
Example: If you wanted to wait until your CLI outputted: "At 10:23am, the CLI completed job #124789124987, but you only cared about a portion of that line, using a search parameter of "the CLI completed job" would return true.
a promise that will resolve true if a match is found, or will throw an error on timeout.
The string you'd like the output to include.
Optional: Test includes output since last call to test.
Optional: Max time to wait for a match (ms).
Wait until a line of your CLI's stdout passes your supplied matching function.
uniqueID is used as an index any time you re-search with the same function. For example if you search and find something, then later you want to find something again, using the same uniqueID will tell Clifry that you want to start where the previous search left off rather than starting again from the beginning of the entire output.
a promise that will resolve true if your test is passed, or will throw an error on timeout.
This is required to enable calling your test multiple times throughout the course of a test.
This will be printed in CliFry's log and should be short but descriptive, so that you can see clearly when your function passed or failed.
Optional: Test includes output since last call to test.
Optional: Max time to wait for a pass (ms).
Waits until your CLI stops on its own, or is already stopped.
A promise that will resolve with the CLI's exit code, or will throw an error on timeout.
Optional: Max time to wait for your CLI to stop on its own (ms).
Generated using TypeDoc
The working directory of the test. Use this if you are loading or storing files as a part of your test.