API Docs for: 0.0.3
Show:

CoreObject Class

Extends EventEmitter
Defined in: src/CoreObject.coffee:5

Available since 0.0.2

Base for all objects

Item Index

Methods

Methods

assert

(
  • expression
  • message
)
static chainable

Defined in src/CoreObject.coffee:47

Available since 0.0.2

Make an assertion and throw an error if it fails

Parameters:

  • expression Boolean

    the test to assert true

  • message String

    the message of the error if assertion is failing

assert

(
  • expression
  • message
)
chainable

Defined in src/CoreObject.coffee:103

Available since 0.0.2

Make an assertion and throw an error if it fails

Parameters:

  • expression Boolean

    the test to assert true

  • message String

    the message of the error if assertion is failing

className

() String static

Defined in src/CoreObject.coffee:18

Available since 0.0.2

Get the name of the class

Returns:

String:

name of the class

className

() String

Defined in src/CoreObject.coffee:78

Available since 0.0.2

Returns the name of the class for this object

Returns:

String:

class name of this object

destroy

()

Defined in src/CoreObject.coffee:154

Available since 0.0.2

Used to destroy the object

identify

() String

Defined in src/CoreObject.coffee:143

Available since 0.0.2

Get a string identification of the object

Returns:

String:

the string identifying the object

lockProperties

(
  • names
)
static chainable

Defined in src/CoreObject.coffee:63

Available since 0.0.2

Lock given properties so that setting them will fail

Parameters:

  • names String multiple

    the name of each property to lock

lockProperties

(
  • names
)
chainable

Defined in src/CoreObject.coffee:117

Available since 0.0.2

Lock given properties so that setting them will fail

Parameters:

  • names String multiple

    the name of each property to lock

log

(
  • [level="debug"]
  • items
)
static chainable

Defined in src/CoreObject.coffee:29

Available since 0.0.2

Log a string with the class name as a prefix

Parameters:

  • [level="debug"] String optional

    level (debug, notice, info, warning, error, danger or fatal)

  • items Mixed multiple

    anything to give back to the logger

log

(
  • [level="debug"]
  • items
)
chainable

Defined in src/CoreObject.coffee:89

Available since 0.0.2

Log a string with the class name as a prefix

Parameters:

  • [level="debug"] String optional

    level (debug, notice, info, warning, error, danger or fatal)

  • items Mixed multiple

    anything to give back to the logger

uuid

() String

Defined in src/CoreObject.coffee:131

Available since 0.0.2

Get the UUID of the object or fail if none defined

Returns:

String:

UUID of the object