Optional
timeout: number = 1000How long to wait for a response before timing out.
NaN
or infinite values will result in the ping never timing out if no response is received,
unless signal is a valid AbortSignal and gets aborted.
Non-NaN
, finite values will be clamped between 0
and Number.MAX_SAFE_INTEGER
inclusive.
Defaults to 1000
.
Optional
ipv6: boolean = falseWhether the endpoint requires ipv6 support. Defaults to false
.
Optional
signal: AbortSignalAn optional AbortSignal which, when passed, will be used to abort awaiting the ping.
Defaults to undefined
.
Generated using TypeDoc
Asynchonously pings a Procedure at a given endpoint to check that it is available and ready to be called. If any errors are thrown, absorbs them and returns
false
.Returns
A Promise which when resolved indicated whether the endpoint is available and ready to handle calls. If errors were thrown, resolves to
false
instead of rejecting.