Members
callError
Call error name to code number mapping
credentials
Credentials factories
getClientChannel
- Source:
- See:
logVerbosity
Log verbosity setting name to code number mapping
makeGenericClientConstructor
- Source:
- See:
Metadata
- Source:
- See:
propagate
Propagate flag name to number mapping
Server
- Source:
- See:
ServerCredentials
ServerCredentials factories
status
Status name to code number mapping
waitForClientReady
- Source:
- See:
writeFlags
Write flag name to code number mapping
Methods
load(filename, formatopt, optionsopt) → {Object.<string, *>}
Load a gRPC object from a .proto file. The options object can provide the
following options:
- convertFieldsToCamelCase: Loads this file with that option on protobuf.js
set as specified. See
https://github.com/dcodeIO/protobuf.js/wiki/Advanced-options for details
- binaryAsBase64: deserialize bytes values as base64 strings instead of
Buffers. Defaults to false
- longsAsStrings: deserialize long values as strings instead of objects.
Defaults to true
- deprecatedArgumentOrder: Use the beta method argument order for client
methods, with optional arguments after the callback. Defaults to false.
This option is only a temporary stopgap measure to smooth an API breakage.
It is deprecated, and new code should not use it.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
filename |
string | Object | The file to load | |
format |
string |
<optional> |
The file format to expect. Must be either 'proto' or 'json'. Defaults to 'proto' |
options |
Object |
<optional> |
Options to apply to the loaded file |
Returns:
The resulting gRPC object
- Type
- Object.<string, *>
loadObject(value, optionsopt) → {Object.<string, *>}
Load a gRPC object from an existing ProtoBuf.Reflect object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
ProtoBuf.Reflect.Namespace | The ProtoBuf object to load. | |
options |
Object |
<optional> |
Options to apply to the loaded object |
Returns:
The resulting gRPC object
- Type
- Object.<string, *>
setLogger(logger)
Sets the logger function for the gRPC module. For debugging purposes, the C
core will log synchronously directly to stdout unless this function is
called. Note: the output format here is intended to be informational, and
is not guaranteed to stay the same in the future.
Logs will be directed to logger.error.
Parameters:
| Name | Type | Description |
|---|---|---|
logger |
Console | A Console-like object. |
setLogVerbosity(verbosity)
Sets the logger verbosity for gRPC module logging. The options are members
of the grpc.logVerbosity map.
Parameters:
| Name | Type | Description |
|---|---|---|
verbosity |
Number | The minimum severity to log |