Namespace: Health
Type Aliases
Check
Ƭ Check: Object
If the requested service is unknown, the call will fail with status NOT_FOUND.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IHealthCheckRequest |
callback | CheckCallback |
Returns
void
▸ (request): Promise<HealthCheckResponse>
Parameters
| Name | Type |
|---|---|
request | IHealthCheckRequest |
Returns
Promise<HealthCheckResponse>
Type declaration
| Name | Type |
|---|---|
name | "Check" |
path | "/grpc.health.v1.Health/Check" |
requestStream | undefined |
requestType | "HealthCheckRequest" |
responseStream | undefined |
responseType | "HealthCheckResponse" |
CheckCallback
Ƭ CheckCallback: (error: Error | null, response?: HealthCheckResponse) => void
Callback as used by grpc.health.v1.Health#check.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | HealthCheckResponse | HealthCheckResponse |
Returns
void
Watch
Ƭ Watch: Object
Performs a watch for the serving status of the requested service. The server will immediately send back a message indicating the current serving status. It will then subsequently send a new message whenever the service's serving status changes.
If the requested service is unknown when the call is received, the server will send a message setting the serving status to SERVICE_UNKNOWN but will not terminate the call. If at some future point, the serving status of the service becomes known, the server will send a new message with the service's serving status.
If the call terminates with status UNIMPLEMENTED, then clients should assume this method is not supported and should not retry the call. If the call terminates with any other status (including OK), clients should retry the call with appropriate exponential backoff.
Call signature
▸ (request, callback): void
Parameters
| Name | Type |
|---|---|
request | IHealthCheckRequest |
callback | WatchCallback |
Returns
void
▸ (request): Promise<HealthCheckResponse>
Parameters
| Name | Type |
|---|---|
request | IHealthCheckRequest |
Returns
Promise<HealthCheckResponse>
Type declaration
| Name | Type |
|---|---|
name | "Watch" |
path | "/grpc.health.v1.Health/Watch" |
requestStream | undefined |
requestType | "HealthCheckRequest" |
responseStream | true |
responseType | "HealthCheckResponse" |
WatchCallback
Ƭ WatchCallback: (error: Error | null, response?: HealthCheckResponse) => void
Callback as used by grpc.health.v1.Health#watch.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | HealthCheckResponse | HealthCheckResponse |
Returns
void