protobuf.js

API documentation

Class: Method

Method

Reflected service method.

new Method(name, type, requestType, responseType, requestStream, responseStream, options, comment, parsedOptions)

method.js, line 25

Constructs a new service method instance.

Name Type Description
name string

Method name
type string | undefined

Method type, usually "rpc"
requestType string

Request message type
responseType string

Response message type
requestStream boolean | Object.<string, *> optional

Whether the request is streamed
responseStream boolean | Object.<string, *> optional

Whether the response is streamed
options Object.<string, *> optional

Declared options
comment string optional

The comment for this method
parsedOptions Array.<Object.<string, *>> optional

Declared options, properly parsed into objects

Extends

Members

comment { string | null }

Comment for this method

filename { string | null }

Defining file name.

fullName readonly{ string }

Full name including leading dot.

name { string }

Unique name within its namespace.

options { Object<string, *> | undefined }

Options.

parent { Namespace | null }

Parent namespace.

parsedOptions { Object<string, *>[] | undefined }

Options properly parsed into objects

requestStream { boolean | undefined }

Whether requests are streamed or not.

requestType { string }

Request type.

resolved { boolean }

Whether already resolved or not.

resolvedRequestType { Type | null }

Resolved request type.

resolvedResponseType { Type | null }

Resolved response type.

responseStream { boolean | undefined }

Whether responses are streamed or not.

responseType { string }

Response type.

root readonly{ Root }

Reference to the root namespace.

type { string }

Method type.

Methods

inherited getOption(name){ * }

object.js, line 273

Gets an option value.

Name Type Description
name string

Option name
Returns:
Type Description
* Option value or undefined if not set

inherited onAdd(parent){ undefined }

object.js, line 156

Called when this object is added to a parent.

Name Type Description
parent ReflectionObject

Parent added to
Returns:
Type Description
undefined

inherited onRemove(parent){ undefined }

object.js, line 171

Called when this object is removed from a parent.

Name Type Description
parent ReflectionObject

Parent removed from
Returns:
Type Description
undefined

inherited resolve(){ ReflectionObject }

method.js, line 151

Resolves this objects type references.

Returns:
Type Description
ReflectionObject this

inherited setOption(name, value, ifNotSet){ ReflectionObject }

object.js, line 286

Sets an option.

Name Type Description
name string

Option name
value *

Option value
ifNotSet boolean | undefined optional

Sets the option only if it isn't currently set
Returns:
Type Description
ReflectionObject this

inherited setOptions(options, ifNotSet){ ReflectionObject }

object.js, line 348

Sets multiple options.

Name Type Description
options Object.<string, *>

Options to set
ifNotSet boolean optional

Sets an option only if it isn't currently set
Returns:
Type Description
ReflectionObject this

inherited setParsedOption(name, value, propName){ ReflectionObject }

object.js, line 308

Sets a parsed option.

Name Type Description
name string

parsed Option name
value *

Option value
propName string

dot '.' delimited full path of property within the option to set. if undefined\empty, will add a new option with that value
Returns:
Type Description
ReflectionObject this

toJSON(toJSONOptions){ IMethod }

method.js, line 134

Converts this method to a method descriptor.

Name Type Description
toJSONOptions IToJSONOptions optional

JSON conversion options
Returns:
Type Description
IMethod Method descriptor

inherited toString(){ string }

object.js, line 359

Converts this instance to its string representation.

Returns:
Type Description
string Class name[, space, full name]

Method.fromJSON(name, json){ Method }

method.js, line 125

Constructs a method from a method descriptor.

Name Type Description
name string

Method name
json IMethod

Method descriptor
Throws:
Type Description
TypeError

If arguments are invalid
Returns:
Type Description
Method Created method