StructureJS

0.15.2

A class based utility library for building modular and scalable web platform applications. Features opt-in classes and utilities which provide a solid foundation and toolset to build your next project.

BaseObject Class

Defined in: ts/BaseObject.ts:3
Module: core
Parent Module: StructureJS

The BaseObject class is an abstract class that provides common properties and functionality for all StructureJS classes.

Index

Show:

Properties

Methods

Properties

sjsId Int public

Defined in ts/BaseObject.ts:15

The sjsId (StructureJS ID) is a unique identifier automatically assigned to most StructureJS objects upon instantiation.

Default: null

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Constructor

BaseObject ()

Defined in ts/BaseObject.ts:3

Methods

destroy () Void public

Defined in ts/BaseObject.ts:49

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.

Returns:

Void:

Example:

destroy() {
     this.disable();

     this._childInstance.destroy();

     super.destroy();
}

getQualifiedClassName () String public

Defined in ts/BaseObject.ts:32

Returns the fully qualified class name of an object.

Returns:

String:

Returns the class name.

Example:

let someClass = new SomeClass();
someClass.getQualifiedClassName();

// SomeClass

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index