1. Home
  2. Classes
  3. MyApi.Child

new Child()

This is the summary of the MyApi child class, test markdown.

Details

MyApi.Class

MyApi.js, line 128

Members

<protected> protectedMember :string

I'm a protected member of the class.

Details
string

"I'm a protected member."

MyApi.Class#protectedMember

MyApi.js, line 135

publicMember :string

I'm a member of the class.

Details
string

"I'm an instance member."

MyApi.Class#publicMember

MyApi.js, line 44

<private> _privateMember :string

I'm a private member of the class.

Details
string

"I'm a private member."

MyApi.Class#_privateMember

MyApi.js, line 61

Methods

anotherMethod( value, obj [, ...objN ] ) → {Object}

This is a another test instance method of the MyApi child class, test markdown.

Description

This method overrides the MyApi.Class#anotherMethod and should remove the exception documentation as it no longer applies. The event should also be updated to reflect it is raised by this class and not the inherited one.

Parameters
Name Type Attributes Description
value *

Any value, test markdown
obj Object

The first object of what could be many, test markdown
objN Object <optional>
<repeatable>

Any additional objects, test markdown
Returns

The combination of all the objects, test markdown.

Fires

This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.

Details

MyApi.Class#anotherMethod

MyApi.js, line 146

testMethod( value, obj [, ...objN ] ) → {Object}

This is a test instance method of the MyApi test class, test markdown.

Description

This method is not overridden in the MyApi.Child class but is simply inherited.

Parameters
Name Type Attributes Description
value *

Any value, test markdown
obj Object

The first object of what could be many, test markdown
objN Object <optional>
<repeatable>

Any additional objects, test markdown
Returns

The combination of all the objects, test markdown.

Fires

This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.

Throws

This is thrown when some condition fails within this method.

Details

MyApi.Class#testMethod

MyApi.js, line 72

Events

"another.my-api"

This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.

Parameters
Name Type Description
e Event

The event object.
custom *

Some custom parameter passed to any listeners.
Details

MyApi.js, line 158