VerifyConnectionOptionsOptions for the cheap (tier-1) verifyConnection probe.
Source src/Hyperlink.ts:51787 lines
export type type VerifyConnectionOptions = {
readonly timeout?: Duration.Input
readonly url?: string
readonly path?: string
readonly all?: boolean
}
Options for the cheap (tier-1)
verifyConnection
probe.
VerifyConnectionOptions = {
readonly timeout?: Duration.Inputtimeout?: import DurationDuration.type Input =
| number
| bigint
| Duration.Duration
| readonly [seconds: number, nanos: number]
| `${number} nano`
| `${number} nanos`
| `${number} micro`
| `${number} micros`
| `${number} milli`
| `${number} millis`
| `${number} second`
| `${number} seconds`
| `${number} minute`
| `${number} minutes`
| `${number} hour`
| `${number} hours`
| `${number} day`
| `${number} days`
| `${number} week`
| `${number} weeks`
| "Infinity"
| "-Infinity"
| Duration.DurationObject
Valid input types that can be converted to a Duration.
When to use
Use when an API should accept any value that Effect can convert into a
Duration, including existing durations, millisecond numbers, nanosecond
bigints, high-resolution tuples, duration strings, infinity strings, or
duration objects.
Details
String inputs accept values like "10 seconds", "500 millis",
"Infinity", and "-Infinity". Finite fractional values that are
normalized to nanoseconds are rounded to the nearest nanosecond, with ties
away from zero.
Input;
readonly url?: string | undefinedurl?: string;
readonly path?: string | undefinedpath?: string;
/** Probe every declared endpoint (default: the {@link selectEndpoint} pick). */
readonly all?: boolean | undefinedProbe every declared endpoint (default: the
selectEndpoint
pick).
all?: boolean;
};
Referenced by 2 symbols