Interface IModule

Represents a collection of functions. This is analogous to a file.

interface IModule {
    addListeners(listeners: IListeners, options?: IListener.Options): Remove;
    delete(): void;
    getErrors(): any[];
    getFunctions(): IFunctionCollection;
    getLanguage(): string;
    getSource(): string;
    toJSON(): CompiledModule;
}

Index

Methods

addListeners delete getErrors getFunctions getLanguage getSource toJSON

Methods

addListeners

addListeners(listeners: IListeners, options?: IListener.Options): Remove
Parameters
- listeners: IListeners
- Optionaloptions: IListener.Options
Returns Remove

delete

delete(): void
Remove the module from the collection.

Returns void

getErrors

getErrors(): any[]
Returns any[]

getFunctions

getFunctions(): IFunctionCollection
Returns the functions in the module.

Returns IFunctionCollection
Remarks
This maybe be empty even if there is source. It is possible that a script might contain only comments or other non-executable code.

getLanguage

getLanguage(): string
The language the function is written in.

Returns string

getSource

getSource(): string
The human-readable source code of the script.

Returns string
Remarks
If this property is null, the module may still have compiled functions.

toJSON

toJSON(): CompiledModule
Returns a JSON representation of the module.

Returns CompiledModule