diff --git a/node/classes.list.html b/node/classes.list.html index cd7d7a48f13..ed05774bd3a 100644 --- a/node/classes.list.html +++ b/node/classes.list.html @@ -1302,7 +1302,7 @@ call's cancelled property will be set to true.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/external-Duplex.html b/node/external-Duplex.html index 79ed90c0539..2ac72c28f67 100644 --- a/node/external-Duplex.html +++ b/node/external-Duplex.html @@ -232,7 +232,7 @@ Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/external-EventEmitter.html b/node/external-EventEmitter.html index 703a1003e37..18359d79c44 100644 --- a/node/external-EventEmitter.html +++ b/node/external-EventEmitter.html @@ -232,7 +232,7 @@ Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/external-GoogleCredential.html b/node/external-GoogleCredential.html index 18d2dbaf196..4defd284d54 100644 --- a/node/external-GoogleCredential.html +++ b/node/external-GoogleCredential.html @@ -230,7 +230,7 @@ Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/external-Readable.html b/node/external-Readable.html index bd7cfd3c748..da45145b75a 100644 --- a/node/external-Readable.html +++ b/node/external-Readable.html @@ -232,7 +232,7 @@ Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/external-Writable.html b/node/external-Writable.html index 62179013bd5..d0e57b08873 100644 --- a/node/external-Writable.html +++ b/node/external-Writable.html @@ -232,7 +232,7 @@ Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/externals.list.html b/node/externals.list.html index 9a47a24e9eb..4e817ee3a5f 100644 --- a/node/externals.list.html +++ b/node/externals.list.html @@ -1302,7 +1302,7 @@ call's cancelled property will be set to true.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/global.html b/node/global.html index 65134253008..6fcb4ea04dc 100644 --- a/node/global.html +++ b/node/global.html @@ -2459,7 +2459,7 @@ RPC operations.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-Call.html b/node/grpc-Call.html index 7e3dca9bfc5..f59107637fd 100644 --- a/node/grpc-Call.html +++ b/node/grpc-Call.html @@ -255,7 +255,7 @@ Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ClientDuplexStream.html b/node/grpc-ClientDuplexStream.html index c6df81fbbc8..82fe3710bc4 100644 --- a/node/grpc-ClientDuplexStream.html +++ b/node/grpc-ClientDuplexStream.html @@ -882,7 +882,7 @@ call

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ClientReadableStream.html b/node/grpc-ClientReadableStream.html index 2b22241782c..5c411819c52 100644 --- a/node/grpc-ClientReadableStream.html +++ b/node/grpc-ClientReadableStream.html @@ -680,7 +680,7 @@ call

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ClientUnaryCall.html b/node/grpc-ClientUnaryCall.html index fc1b35d9b55..91cc240a756 100644 --- a/node/grpc-ClientUnaryCall.html +++ b/node/grpc-ClientUnaryCall.html @@ -678,7 +678,7 @@ call

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ClientWritableStream.html b/node/grpc-ClientWritableStream.html index 7155ea2f3d7..1ba60eefe24 100644 --- a/node/grpc-ClientWritableStream.html +++ b/node/grpc-ClientWritableStream.html @@ -882,7 +882,7 @@ call

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ServerDuplexStream.html b/node/grpc-ServerDuplexStream.html index 094db572c33..a37351eed1f 100644 --- a/node/grpc-ServerDuplexStream.html +++ b/node/grpc-ServerDuplexStream.html @@ -711,7 +711,7 @@ call's cancelled property will be set to true.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ServerReadableStream.html b/node/grpc-ServerReadableStream.html index d86eb7e3178..44030c5b0c1 100644 --- a/node/grpc-ServerReadableStream.html +++ b/node/grpc-ServerReadableStream.html @@ -974,7 +974,7 @@ call's cancelled property will be set to true.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ServerUnaryCall.html b/node/grpc-ServerUnaryCall.html index 50435065404..3edb853a3a3 100644 --- a/node/grpc-ServerUnaryCall.html +++ b/node/grpc-ServerUnaryCall.html @@ -878,7 +878,7 @@ call's cancelled property will be set to true.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc-ServerWritableStream.html b/node/grpc-ServerWritableStream.html index a4892e516b8..c2bb46e31ca 100644 --- a/node/grpc-ServerWritableStream.html +++ b/node/grpc-ServerWritableStream.html @@ -903,7 +903,7 @@ call's cancelled property will be set to true.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.Channel.html b/node/grpc.Channel.html index 8c69b876393..c977cc3c2ff 100644 --- a/node/grpc.Channel.html +++ b/node/grpc.Channel.html @@ -231,7 +231,9 @@ here.

-

A map of channel options that will be passed to the core

+

A map of channel options that will be passed to the core. + The available options are listed in + this document.

@@ -1277,7 +1279,7 @@ class.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.Client.html b/node/grpc.Client.html index df2032b7886..3dfedecb9bb 100644 --- a/node/grpc.Client.html +++ b/node/grpc.Client.html @@ -230,7 +230,210 @@ -

Options to apply to channel creation

+

Options to apply to channel creation. Any of + the channel arguments + can be used here in addition to specific client options.

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
interceptors + + +Array.<grpc~Interceptor> + + + + + + + <optional>
+ + + + + +

Interceptors to apply to each request

interceptor_providers + + +Array.<grpc~InterceptorProvider> + + + + + + + <optional>
+ + + + + +

Interceptor providers + to apply interceptors to each request depending on the method definition. At most + one of the interceptors and interceptor_providers options may be set.

callInvocationTransformer + + +grpc.Client~callInvocationTransformer + + + + + + + <optional>
+ + + + + +
channelOverride + + +grpc.Channel + + + + + + + <optional>
+ + + + + +

Channel to use instead of constructing a new one. + If set, the address, credentials, channel arguments options, and channelFactoryOverride + option will all be ignored.

channelFactoryOverride + + +grpc.Client~channelFactory + + + + + + + + + + +

Function to use instead of + the Channel constructor when creating the Client's channel.

+ + @@ -1969,6 +2172,363 @@ start connecting if it has not already done so.

+ + + + +
+
+

<inner> callInvocationTransformer(callProperties)

+ + +
+
+ + +
+

Call invocation transformer. Has access to the full call properties before a +call is processed and can modify most of those properties. Some modifications +will have no effect or may cause problems.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
callProperties + + +grpc.Client~CallProperties + + + + +

The original call properties

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

The modified call properties.

+
+ + + +
+
+ Type +
+
+ +grpc.Client~CallProperties + + + +
+
+ + + + + +
+ + + +
+
+

<inner> channelFactory(target, credentials, options)

+ + +
+
+ + +
+

A function that functionally replaces the Channel constructor.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
target + + +string + + + + +

The address of the server to connect to

credentials + + +grpc.ChannelCredentials + + + + +

Channel credentials to use when connecting

options + + +grpc~ChannelOptions + + + + +

A map of channel options that will be passed to the core. + The available options are listed in + this document.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

This can either be an actual channel object, or an object with the + same API.

+
+ + + +
+
+ Type +
+
+ +grpc.Channel + + + +
+
+ + + + +
@@ -2263,6 +2823,275 @@ start connecting if it has not already done so.

+ + + + + + + + + + + + + + + + + + + + + + + + +
+
+

CallProperties

+ + +
+
+ +
+

Properties of a call, for use with a grpc.Client~callInvocationTransformer.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
argument + + +* + + + + +

The call argument. Only preset if the method is unary or server streaming.

metadata + + +grpc.Metadata + + + + +

The request metadata

call + + +grpc~Call + + + + +

The call object that will be returned by the client method

channel + + +grpc.Channel + + + + +

The channel that will be used to make a request

methodDefinition + + +grpc~MethodDefinition + + + + +

The MethodDefinition object that describes this method

options + + +grpc.Client~CallOptions + + + + +

The call options passed when making this request

callback + + +grpc.Client~requestCallback + + + + +

The callback that will handle the response. + Only present if this method is unary or client streaming.

+
+ + + + + + + + + + + + + + + + + + + + @@ -2502,7 +3331,7 @@ start connecting if it has not already done so.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.Metadata.html b/node/grpc.Metadata.html index b83c3df8354..95d8ba277f0 100644 --- a/node/grpc.Metadata.html +++ b/node/grpc.Metadata.html @@ -121,7 +121,7 @@
-

new Metadata()

+

new Metadata( [options])

@@ -139,6 +139,264 @@ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
options + + +Object + + + + + + + <optional>
+ + + + + +

Boolean options for the beginning of the call. + These options only have any effect when passed at the beginning of + a client request.

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
idempotentRequest + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + false + +

Signal that the request + is idempotent

waitForReady + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Signal that the call should + not return UNAVAILABLE before it has started.

cacheableRequest + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + false + +

Signal that the call is + cacheable. GRPC is free to use GET verb.

corked + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + false + +

Signal that the initial metadata + should be corked.

+ +
+ +
@@ -987,6 +1245,330 @@ with that key. Normalizes the key.

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

setOptions(options)

+ + +
+
+ + +
+

Set options on the metadata object

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +

Boolean options for the beginning of the call. + These options only have any effect when passed at the beginning of + a client request.

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
idempotentRequest + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + false + +

Signal that the request + is idempotent

waitForReady + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Signal that the call should + not return UNAVAILABLE before it has started.

cacheableRequest + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + false + +

Signal that the call is + cacheable. GRPC is free to use GET verb.

corked + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + false + +

Signal that the initial metadata + should be corked.

+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + @@ -1070,7 +1652,7 @@ with that key. Normalizes the key.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.Server.html b/node/grpc.Server.html index 1094e690854..0f19d32fbf2 100644 --- a/node/grpc.Server.html +++ b/node/grpc.Server.html @@ -195,7 +195,8 @@ incoming requests to those handlers

Options that should be passed to the internal server - implementation

+ implementation. The available options are listed in + this document.

@@ -2506,7 +2507,7 @@ responses.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.ServerCredentials.html b/node/grpc.ServerCredentials.html index ba47a91c810..881c9b71446 100644 --- a/node/grpc.ServerCredentials.html +++ b/node/grpc.ServerCredentials.html @@ -759,7 +759,7 @@ Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:29-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.credentials-CallCredentials.html b/node/grpc.credentials-CallCredentials.html index 13751953096..1410d92fccf 100644 --- a/node/grpc.credentials-CallCredentials.html +++ b/node/grpc.credentials-CallCredentials.html @@ -260,7 +260,7 @@ be created using the factory functions in grpc.c Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.credentials-ChannelCredentials.html b/node/grpc.credentials-ChannelCredentials.html index 4a3a4758f02..eb13c5487fc 100644 --- a/node/grpc.credentials-ChannelCredentials.html +++ b/node/grpc.credentials-ChannelCredentials.html @@ -260,7 +260,7 @@ be created using the factory functions in grpc.c Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.credentials.html b/node/grpc.credentials.html index ea25b6c6c1f..3dbff57afdc 100644 --- a/node/grpc.credentials.html +++ b/node/grpc.credentials.html @@ -1661,7 +1661,7 @@ options can be passed in the fourth argument as described below.

Documentation generated by JSDoc 3.5.5 - on 2018-11-29T11:16:28-08:00 + on 2019-07-15T16:38:16-07:00 using the DocStrap template. diff --git a/node/grpc.html b/node/grpc.html index 1ca93aa8d20..95090029656 100644 --- a/node/grpc.html +++ b/node/grpc.html @@ -4145,6 +4145,77 @@ start connecting if it has not already done so.

+ + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

CoreMetadata

+ + +
+
+ +
+

Metadata representation as passed to and the native addon

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + @@ -4891,7 +4962,78 @@ passed.

+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

ProtobufTypeDefinition

+ + +
+
+ +
+

An object that defines a protobuf type

+
+ + + +
Type:
+