Class Mixin

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

Overview

Public: 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

Public: Construct a mixin node - The mixin node (a Object) fileName - The filename (a String) options - The parser options (a Object) comment - The comment node (a Object)

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

Public: Get the mixin doc Returns the mixin doc (a [Doc])

Returns:

  • Returns the mixin doc (a [Doc])

String ::getFileName() Source

Public: Get the source file name. Returns the filename of the mixin (a String).

Returns:

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

::getFullName() Source

Public: Alias for ::getMixinName

Array ::getMethods() Source

Public: Get all methods. Returns an Array of all the Methods.

Returns:

String ::getMixinName() Source

Public: Get the full mixin name Returns full mixin name (a String).

Returns:

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

String ::getName() Source

Public: Gets the mixin name Returns the name (a String).

Returns:

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

String ::getNamespace() Source

Public: Get the mixin namespace Returns the namespace (a String).

Returns:

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

Object ::toJSON() Source

Public: Get a JSON representation of the object Returns the JSON object (a Object).

Returns:

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