Class: File
Defined in: | src/nodes/file.coffee |
Inherits: | Class |
Overview
The file class is a fake
class that wraps the
Instance Method Summary
-
.constructor(node, fileName, lineMapping, options)
Constructor
Construct a
File
object. - String .getFileName() Returns the file class name.
- String .getFullName() Get the full file name with path
- String .getPath() Get the file path
- .isEmpty() Test if the file doesn't contain any top-level public methods.
- Object .toJSON() Get a JSON representation of the object
Inherited Method Summary
Methods inherited from Class
.constructor, .getFileName, .getDoc, .getFullName, .getClassName, .getName, .getLocation, .getNamespace, .getParentClassName, .getMethods, .getVariables, .toJSON
Methods inherited from Node
Constructor Details
.constructor(node, fileName, lineMapping, options)
Construct a File
object.
Instance Method Details
String .getFileName()
Returns the file class name.
String .getFullName()
Get the full file name with path
String .getPath()
Get the file path
.isEmpty()
Test if the file doesn't contain any top-level public methods.
Object .toJSON()
Get a JSON representation of the object