step-security/Wait on
Waits for resource(s) to be accessible
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| resource | Resources types are defined by their prefix, if no prefix is present, the resource is assumed to be of type 'file' resource prefixes are: file: - regular file (also default type). ex: file:/path/to/file http: - HTTP HEAD returns 2XX response. ex: http://m.com:90/foo https: - HTTPS HEAD returns 2XX response. ex: https://my/bar http-get: - HTTP GET returns 2XX response. ex: http://m.com:90/foo https-get: - HTTPS GET returns 2XX response. ex: https://my/bar tcp: - TCP port is listening. ex: 1.2.3.4:9000 or foo.com:700 socket: - Domain Socket is listening. ex: socket:/path/to/sock For http over socket, use http://unix:SOCK_PATH:URL_PATH like http://unix:/path/to/sock:/foo/bar or http-get://unix:/path/to/sock:/foo/bar | yes | — |
| config | js or json config file, useful for http(s) options | no | — |
| delay | Initial delay before checking for resources in ms, default 0 | no | 0 |
| httpTimeout | Maximum time in ms to wait for an HTTP HEAD/GET request, default 0 which results in using the OS default | no | 0 |
| interval | Interval to poll resources in ms, default 250ms | no | 250 |
| log | Log resources begin waited on and when complete or errored | no | false |
| reverse | Reverse operation, wait for resources to NOT be available | no | false |
| simultaneous | Simultaneous / Concurrent connections to a resource, default Infinity Setting this to 1 would delay new requests until previous one has completed. Used to limit the number of connections attempted to a resource at a time' | no | — |
| timeout | Maximum time in ms to wait before exiting with failure (1) code, default Infinity | no | — |
| tcpTimeout | Maximum time in ms for tcp connect, default 300ms | no | 300 |
| verbose | Enable debug output to stdout | no | false |
| window | Stability window, the time in ms defining the window of time that resource needs to have not changed (file size or availability) before signalling success, default 750ms. If less than interval, it will be reset to the value of interval. This is only used for files, other resources are considered available on first detection. | no | 750 |
Outputs
no outputs