Class: Mixin

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

Overview

A CoffeeScript mixins

Instance Method Summary

Inherited Method Summary

Methods inherited from Node

.findAncestor

Constructor Details

.constructor(node, fileName, options, comment) Source

Construct a mixin

Parameters:

  • nodethe mixin node (a [Object])
  • thefilename (a [String])
  • optionsthe parser options (a [Object])
  • commentthe comment node (a [Object])

Instance Method Details

.getDoc() Source

Get the mixin doc

Returns:

  • Returns the mixin doc (a [Doc])

.getFileName() Source

Get the source file name.

Returns:

  • Returns the filename of the mixin (a [String])

.getFullName() Source

Alias for {Mixin#getMixinName}

.getMethods() Source

Get all methods.

Returns:

  • Returns (a ) [Array] the methods

.getMixinName() Source

Get the full mixin name

Returns:

  • Returns full mixin name (a [String])

.getName() Source

Get the mixin name

Returns:

  • Returns the name (a [String])

.getNamespace() Source

Get the mixin namespace

Returns:

  • Returns the namespace (a [String])

.getVariables() Source

Get all variables.

Returns:

  • Returns (a ) [Array] the variables

.toJSON() Source

Get a JSON representation of the object

Returns:

  • Returns the JSON object (a [Object])