Class: Method

Defined in: src/nodes/method.coffee
Inherits: Node

Overview

A CoffeeScript method

Instance Method Summary

Inherited Method Summary

Methods inherited from Node

.findAncestor

Constructor Details

.constructor(entity, node, lineMapping, options, comment) Source

Construct a method

@param [Class] entity the methods class @param [Object] node the node @param [Object] options the parser options @param [Object] comment the comment node

Instance Method Details

.getDoc() Source

Get the class doc

@return [Doc] the class doc

Number .getLocation() Source

Get the source line number

Returns:

  • (Number) — Returns a {Number}

.getName() Source

Get the method name

@return [String] the method name

.getParameters() Source

Get the method parameters

@param [Array] the method parameters

.getShortSignature() Source

Get the short method signature.

@return [String] the short signature

.getSignature() Source

Get the full method signature.

@return [String] the signature

.getType() Source

Get the method type, either class or instance

@return [String] the method type

.toJSON() Source

Get a JSON representation of the object

@return [Object] the JSON object