Class: Mixin

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

Overview

The Node representation of 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:

  • (Object) nodeThe mixin node (a Object)
  • (String) fileNameThe filename (a String)
  • (Object) optionsThe parser options (a Object)
  • (Object) commentThe comment node (a Object)

Instance Method Details

::getDoc() Source

Get the mixin doc

Returns:

  • Returns the mixin doc (a [Doc])

String ::getFileName() Source

Get the source file name.

Returns:

  • (String) — Returns the filename of the mixin (a String).

::getFullName() Source

Alias for ::getMixinName

Array ::getMethods() Source

Get all methods.

Returns:

String ::getMixinName() Source

Get the full mixin name

Returns:

  • (String) — Returns full mixin name (a String).

String ::getName() Source

Gets the mixin name

Returns:

  • (String) — Returns the name (a String).

String ::getNamespace() Source

Get the mixin namespace

Returns:

  • (String) — Returns the namespace (a String).

Object ::toJSON() Source

Get a JSON representation of the object

Returns:

  • (Object) — Returns the JSON object (a Object).