Class: VirtualMethod

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

Overview

A virtual method that has been declared by the @method tag.

Instance Method Summary

Inherited Method Summary

Methods inherited from Node

.findAncestor

Constructor Details

.constructor(entity, doc, options) Source

Construct a virtual method

Parameters:

  • entitythe methods class (a [Class])
  • docthe virtual doc (a [Doc])
  • optionsthe parser options (a [Object])

Instance Method Details

.getCoffeeScriptSource() Source

Get the method source in CoffeeScript

Returns:

  • Returns the CoffeeScript source (a [String])

.getDoc() Source

Get the class doc

Returns:

  • Returns the class doc (a [Doc])

.getJavaScriptSource() Source

Get the method source in JavaScript

Returns:

  • Returns the JavaScript source (a [String])

.getName() Source

Get the method name

Returns:

  • Returns the method name (a [String])

.getParameters() Source

Get the method parameters

Parameters:

  • paramsThe method parameters

.getShortSignature() Source

Get the short method signature.

Returns:

  • Returns the short signature (a [String])

.getSignature() Source

Get the full method signature.

Returns:

  • Returns the signature (a [String])

.getType() Source

Get the method type, either class, instance or mixin.

Returns:

  • Returns the method type (a [String])

.toJSON() Source

Get a JSON representation of the object

Returns:

  • Returns the JSON object (a [Object])