Class Class

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

Overview

Public: The Node representation of a CoffeeScript class.

Subclasses

File

Instance Method Summary

String ::getClassName() Get the full class name
::getDoc() Get the class doc
String ::getFileName() Get the source file name.
String ::getFullName() Alias for ::getClassName
Number ::getLocation() Get the source line number
Array ::getMethods() Get all methods.
String ::getName() Get the class name
String ::getNamespace() Get the class namespace
String ::getParentClassName() Get the full parent class name
Array ::getVariables() Get all variables.
Object ::toJSON() Get a JSON representation of the object

Inherited Method Summary

Methods inherited from Node

.findAncestor

Instance Method Details

String ::getClassName() Source

Public: Get the full class name Returns the class (a String)

Returns:

(String) — Returns the class (a String)

::getDoc() Source

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

Returns:

Returns the class doc (a [Doc])

String ::getFileName() Source

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

Returns:

(String) — Returns the filename of the class (a String)

String ::getFullName() Source

Public: Alias for ::getClassName Returns the full class name (a String)

Returns:

(String) — Returns the full class name (a String)

Number ::getLocation() Source

Public: Get the source line number Returns a Number.

Returns:

(Number) — Returns a Number.

Array ::getMethods() Source

Public: Get all methods. Returns the methods as an Array.

Returns:

(Array) — Returns the methods as an Array.

String ::getName() Source

Public: Get the class name Returns the name (a String)

Returns:

(String) — Returns the name (a String)

String ::getNamespace() Source

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

Returns:

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

String ::getParentClassName() Source

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

Returns:

(String) — Returns the parent class name (a String).

Array ::getVariables() Source

Public: Get all variables. Returns the variables as an Array.

Returns:

(Array) — Returns the variables as an Array.

Object ::toJSON() Source

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

Returns:

(Object) — Returns the JSON object (an Object)