This repository was archived by the owner on Dec 9, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathBaseObject.d.ts
More file actions
61 lines (61 loc) · 1.89 KB
/
BaseObject.d.ts
File metadata and controls
61 lines (61 loc) · 1.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/**
* The {{#crossLink "BaseObject"}}{{/crossLink}} class is an abstract class that provides common properties and functionality for all StructureJS classes.
*
* @class BaseObject
* @module StructureJS
* @submodule core
* @requires Util
* @constructor
* @author Robert S. (www.codeBelt.com)
*/
declare class BaseObject {
/**
* The sjsId (StructureJS ID) is a unique identifier automatically assigned to most StructureJS objects upon instantiation.
*
* @property sjsId
* @type {int}
* @default null
* @writeOnce
* @readOnly
* @public
*/
sjsId: number;
constructor();
/**
* Returns the fully qualified class name of an object.
*
* @method getQualifiedClassName
* @returns {string} Returns the class name.
* @public
* @example
* let someClass = new SomeClass();
* someClass.getQualifiedClassName();
*
* // SomeClass
*/
getQualifiedClassName(): string;
/**
* The purpose of the destroy method is to make an object ready for garbage collection. This
* should be thought of as a one way function. Once destroy is called no further methods should be
* called on the object or properties accessed. It is the responsibility of those who implement this
* function to stop all running Timers, all running Sounds, and take any other steps necessary to make an
* object eligible for garbage collection.
*
* By default the destroy method will null out all properties of the class automatically. You should call destroy
* on other objects before calling the super.
*
* @method destroy
* @return {void}
* @public
* @example
* destroy() {
* this.disable();
*
* this._childInstance.destroy();
*
* super.destroy();
* }
*/
destroy(): void;
}
export default BaseObject;