Skip to content

Commit 794afa7

Browse files
authored
Update README.md
1 parent c2fb609 commit 794afa7

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ jobs:
7575
7676
## wait-for
7777
78-
Use for pausing scripts until a command passes.
78+
runs a command until it passes or timeout is reached.
7979
80-
Use cases:
80+
### Use cases:
8181
8282
- Docker containers that have to wait for a database server to start
8383
- Test scripts that have to wait for your project to initialize.
@@ -87,3 +87,13 @@ Use cases:
8787
wait-for mysql-ready
8888
wait-for curl https://deploy-url/ready
8989
```
90+
91+
### Options
92+
93+
```
94+
# SLEEP: Length of time to wait in-between running the command.
95+
# CHAR: The character to print after every command run.
96+
# OUTPUT: Set to 'all' to print all output, set to 'out' to print just stdOut, set to "err" to print just stdErr.
97+
# TIMEOUT: Default: 30. Exit with an error if process doesn't pass within this time.
98+
# SILENT: Set to 1 to not print any output except the timeout exceeded error. Useful when running from other scripts. See wait-mysql
99+
```

0 commit comments

Comments
 (0)