Class: Method

Extends

• ReflectionObject

Members

comment { string | null }

method.js, line 102

Comment for this method

filename { string | null }

object.js, line 103

Defining file name.

fullName readonly{ string }

object.js, line 123

Full name including leading dot.

name { string }

object.js, line 50

Unique name within its namespace.

options { Object<string, *> | undefined }

object.js, line 38

Options.

parent { Namespace | null }

object.js, line 85

Parent namespace.

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

method.js, line 108

Options properly parsed into objects

path { string }

method.js, line 84

gRPC-style method path.

requestStream { true | undefined }

method.js, line 66

Whether requests are streamed or not.

requestType { string }

method.js, line 60

Request type.

resolved { boolean }

object.js, line 91

Whether already resolved or not.

resolvedRequestType { Type | null }

method.js, line 90

Resolved request type.

resolvedResponseType { Type | null }

method.js, line 96

Resolved response type.

responseStream { true | undefined }

method.js, line 78

Whether responses are streamed or not.

responseType { string }

method.js, line 72

Response type.

root readonly{ Root }

object.js, line 108

Reference to the root namespace.

type { string }

method.js, line 54

Method type.

Methods

inherited getOption(name)→{ * }

object.js, line 272

Gets an option value.

Parameters:

name

string

Option name

Returns:

*	Option value or undefined if not set

inherited onAdd(parent)→{ undefined }

object.js, line 155

Called when this object is added to a parent.

Parameters:

parent

ReflectionObject

Parent added to

Returns:

undefined

inherited onRemove(parent)→{ undefined }

object.js, line 170

Called when this object is removed from a parent.

Parameters:

parent

ReflectionObject

Parent removed from

Returns:

undefined

inherited resolve()→{ ReflectionObject }

method.js, line 157

Resolves this objects type references.

Returns:

ReflectionObject

this

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

object.js, line 285

Sets an option.

Parameters:

name	string	Option name
value	*	Option value
ifNotSet	boolean | undefined	optional Sets the option only if it isn't currently set

Returns:

ReflectionObject

this

inherited setOptions(options, ifNotSet)→{ ReflectionObject }

object.js, line 347

Sets multiple options.

Parameters:

options	Object.<string, *>	Options to set
ifNotSet	boolean	optional Sets an option only if it isn't currently set

Returns:

ReflectionObject

this

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

object.js, line 307

Sets a parsed option.

Parameters:

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:

ReflectionObject

this

toJSON(toJSONOptions)→{ IMethod }

method.js, line 140

Converts this method to a method descriptor.

Parameters:

toJSONOptions

IToJSONOptions

optional JSON conversion options

Returns:

IMethod

Method descriptor

inherited toString()→{ string }

object.js, line 358

Converts this instance to its string representation.

Returns:

string

Class name[, space, full name]

Method.fromJSON(name, json)→{ Method }

method.js, line 131

Constructs a method from a method descriptor.

Parameters:

name	string	Method name
json	IMethod	Method descriptor

Throws:

TypeError

If arguments are invalid

Returns:

Method

Created method