HTTP method (verb) at which the method is available. One of: get, post (default), put, del, or all

[isStatic]

Boolean

Whether the method is a static method or a prototype method.

[returns]

Array or Object

Specifies the remote method's callback arguments; either a single argument as an object or an ordered set of arguments as an array.
The err argument is assumed; do not specify. NOTE: Can have the same properties as
accepts, except for http.target.

Additionally, one of the callback arguments can have type: 'file' and
root:true, in which case this argument is sent in the raw form as
a response body. Allowed values: String, Buffer or ReadableStream

[shared]

Boolean

Whether the method is shared. Default is true.

[status]

Number

The default status code.

Class Properties

Name

Type

Description

name

String

The method name.

aliases

Array.<String>

An array of method aliases.

isStatic

Boolean

Whether the method is static; from options.isStatic. Default is true.

accepts

Array or Object

See options.accepts.

returns

Array or Object

See options.returns.

errors

Array or Object

See options.errors.

description

String

Text description of the method.

notes

String

Additional notes, used by API documentation generators like Swagger.

http

String

rest

String

shared

String

[documented]

Boolean

Default: true. Set to false to exclude the method from Swagger metadata.

Class: SharedMethod Static Methods

coerceAccepts(uarg, desc)

Coerce an 'accepts' value into its final type.
If using HTTP, some coercion is already done in http-context.