Document timeout about terminus HOT 2 CLOSED

We do not support a global timeout because it wouldn’t make sense in my eyes. Instead the timeout option can be given to individual health indicators as option.
The option parameter is usually the last parameter of a function.

For example the DNSHealthIndicator:

dns.pingCheck('google', 'https://google.com', { timeout: 800 })

The promiseTimeout is used for internal stuff, to extend promises with this timeout option, if it is not supported (e.g. DatabaseHealthIndicator uses it when running a SQL check).

I could extend the DNSHealthIndicator example so the users understands that the last parameter contains these kind of optional options. Would that be sufficient?

from terminus.

For the documentation problem, yes this would suffice.

But, about design:
Timeout should be the responsibility of the library, not the responsibility of the author of the healthcheck.
Any healtcheck should be timeout protected, and nest-terminus can bring that as the default. This means that developing a new HealthIndicator would only means implementing the actual call (db, smtp...).

from terminus.