My favorites | Sign in
Logo
                
API  
objx - API Documentation

New to objx? - Read the getting started article

objx - API Documentation

Core objx methods

objx comes with a few functions that are core to the platform. These will always be available within objx environments no matter what plugins you have included. It is possible for plugins to add capabilities to these core methods but they should never prevent the original method from functioning or operating in the expected way. For example, objx.type.js adds type conversion to the type() method - but does not stop type() from working in its own right.

Properties

Properties are items in the objx namespace that globally control the behaviour of the framework.

ODebug Boolean value indicating whether objx is in debug mode or not. If false a lot of helpful checking will be omitted in favour of slight performance enhancements
OVersion A string containing the version of this objx library

Instance methods (objx(object).)

Instance methods are methods that are run on an instance of objx.

extend() Extends the object with other properties or functions
obj() Gets or sets the object being enhanced
requires() Indicates that another plugin is required (read more about requiring and providing)
size() Gets the size of the object.
type() Gets a string describing the type of the object and performs conversions.

Static methods (objx.)

Static methods are always available by directly making calls to them. These methods do not run against instances of objx.

OArray() Ensures an object is an array
OBind() Binds context (and optionally arguments) to functions
OError() Throws an error
OExtend() Extends an object with other properties and functions
OIndex Gets the real index (see magicIndexes)
OIndexRange Gets a real index range (see magicIndexes)
OIsObjx() Checks whether an object is an instance of objx or not
OProvided() Checks whether a plugin has been provided or not (read more about requiring and providing)
OProvides() Indicates that a plugin has been provided (read more about requiring and providing)
ORequires() Indicates that a plugin is required (read more about requiring and providing)
OType() Gets the type of an object.

What is the difference between instance and static methods?

Is it that simple?

The core objx platform is very simple focusing on the common core problems. Functionality is added by plugins.

Hosted by Google Code