new Script()
An element that can be added to a folder
Extends
Methods
deregister()
Deregisters the element. The id will be undefined afterwards. Equivalent to setId(undefined)
- Inherited From
- See
- setId
eval()
Evaluates the script. Equivalent to eval(source())
- Version
- Experimental feature, might be removed at any time
- Since
- 5.4.2
id() → {string}
Returns the registered ID, or undefined if not registered.
- Inherited From
Returns:
- Type:
- string
module() → {object}
Returns the module exports of the script
- Version
- Experimental feature, might be removed at any time
- Since
- 5.4.2
Returns:
- Type:
- object
name() → {string}
Returns the name of the script
- Since
- 5.4.2
Returns:
- Type:
- string
parentFolders() → {Array.<$k.Folder>}
Returns the folders that contain this element
- Inherited From
Returns:
- Type:
- Array.<$k.Folder>
registryType() → {string}
Returns the name of the registry that contains elements of this type
- Inherited From
Returns:
- Type:
- string
setId(id, replaceScriptReferences)
Registers the element with the given ID. If the element has already been registered, then the id changes. If the id is undefined, then the element will be deregistered.
Parameters:
| Name | Type | Description |
|---|---|---|
id | string | The ID |
replaceScriptReferences | boolean | True if ID references in scripts should be replaced. Only done when the old and the new ID is not undefined. |
- Inherited From
source() → {string}
Returns the script source code
- Version
- Experimental feature, might be removed at any time
- Since
- 5.4.2
Returns:
- Type:
- string