Class: Method

Extends

• ReflectionObject

Members

comment { string | null }

Comment text, if any.

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.

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

Method.fromJSON(name, json){ Method }

src/method.js, line 109

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

inherited getOption(name){ * }

src/object.js, line 153

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 }

src/object.js, line 113

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 }

src/object.js, line 128

Called when this object is removed from a parent.

Name	Type	Description
parent	ReflectionObject	Parent removed from

Returns:

Type	Description
undefined

inherited resolve(){ ReflectionObject }

src/object.js, line 140

Resolves this objects type references.

Returns:

Type	Description
ReflectionObject	this

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

src/object.js, line 166

Sets an option.

Name	Type	Description
name	string	Option name
value	*	Option value
ifNotSet	boolean	optional Sets the option only if it isn't currently set

Returns:

Type	Description
ReflectionObject	this

inherited setOptions(options, ifNotSet){ ReflectionObject }

src/object.js, line 178

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

toJSON(){ IMethod }

src/method.js, line 117

Converts this method to a method descriptor.

Returns:

Type	Description
IMethod	Method descriptor

inherited toString(){ string }

src/object.js, line 189

Converts this instance to its string representation.

Returns:

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