archive-gh-me/grpc-node
1
0
Fork 0
mirror of https://github.com/grpc/grpc-node.git synced 2025-12-08 18:23:54 +00:00
Code Issues Projects Releases Wiki Activity

Fix the default value of waitForReady in doc

Browse Source 
In my usecase, the default behavious of `waitForReady` for RPC is `false` that not in accord with the doc. After digging into the source codes, probably the doc is incorrect.

Signed-off-by: imjoey <majunjiev@gmail.com>
This commit is contained in:
imjoey 2019-10-29 14:55:34 +08:00
parent 92f24eaae6
commit 39f11520f3
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/grpc-js/src/metadata.ts
View File

@ -66,7 +66,7 @@ export interface MetadataOptions {
/* Signal that the request is idempotent. Defaults to false */
idempotentRequest?: boolean;
/* Signal that the call should not return UNAVAILABLE before it has
* started. Defaults to true. */
* started. Defaults to false. */
waitForReady?: boolean;
/* Signal that the call is cacheable. GRPC is free to use GET verb.
* Defaults to false */

2
packages/grpc-native-core/index.d.ts vendored
View File

@ -554,7 +554,7 @@ declare module "grpc" {
/* Signal that the request is idempotent. Defaults to false */
idempotentRequest?: boolean;
/* Signal that the call should not return UNAVAILABLE before it has
* started. Defaults to true. */
* started. Defaults to false. */
waitForReady?: boolean;
/* Signal that the call is cacheable. GRPC is free to use GET verb.
* Defaults to false */

4
packages/grpc-native-core/src/metadata.js
View File

@ -37,7 +37,7 @@ const CORKED_FLAG = 0x100;
* a client request.
* @param {boolean=} [options.idempotentRequest=false] Signal that the request
* is idempotent
* @param {boolean=} [options.waitForReady=true] Signal that the call should
* @param {boolean=} [options.waitForReady=false] Signal that the call should
* not return UNAVAILABLE before it has started.
* @param {boolean=} [options.cacheableRequest=false] Signal that the call is
* cacheable. GRPC is free to use GET verb.
@ -170,7 +170,7 @@ Metadata.prototype.clone = function() {
* a client request.
* @param {boolean=} [options.idempotentRequest=false] Signal that the request
* is idempotent
* @param {boolean=} [options.waitForReady=true] Signal that the call should
* @param {boolean=} [options.waitForReady=false] Signal that the call should
* not return UNAVAILABLE before it has started.
* @param {boolean=} [options.cacheableRequest=false] Signal that the call is
* cacheable. GRPC is free to use GET verb.