Show:
API

Matter.Matter

Defined in: src/core/Matter.js:1

The Matter module is the top level namespace. It also includes a function for installing plugins on top of the library.

Methods

Matter.Matter.after

(path, func)
→ Function

Chains a function to excute after the original function on the given path relative to Matter. See also docs for Common.chain.

Parameters

  • path String

    The path relative to Matter

  • func Function

    The function to chain after the original

Returns

Function

The chained function that replaced the original

src/core/Matter.js:73 · Usages · Examples

Matter.Matter.before

(path, func)
→ Function

Chains a function to excute before the original function on the given path relative to Matter. See also docs for Common.chain.

Parameters

  • path String

    The path relative to Matter

  • func Function

    The function to chain before the original

Returns

Function

The chained function that replaced the original

src/core/Matter.js:60 · Usages · Examples

Matter.Matter.use

(plugin...)

Installs the given plugins on the Matter namespace. This is a short-hand for Plugin.use, see it for more information. Call this function once at the start of your code, with all of the plugins you wish to install as arguments. Avoid calling this function multiple times unless you intend to manually control installation order.

Parameters

  • plugin Function multiple

    The plugin(s) to install on base (multi-argument).

src/core/Matter.js:48 · Usages · Examples

Properties / Options

The following properties if specified below are for objects created by Matter.Matter.create and may be passed to it as options.

Matter.name

String

The library name.

src/core/Matter.js:16 · Usages · Examples

Matter.used

Array

The plugins that have been installed through Matter.Plugin.install. Read only.

src/core/Matter.js:40 · Usages · Examples

Matter.uses

Array

A list of plugin dependencies to be installed. These are normally set and installed through Matter.use. Alternatively you may set Matter.uses manually and install them by calling Plugin.use(Matter).

src/core/Matter.js:32 · Usages · Examples

Matter.version

String

The library version.

src/core/Matter.js:24 · Usages · Examples