Scope

Create a new PlexusJS plugin

• Scope
  • .state(item) ⇒
  • .computed(item) ⇒
  • .event() ⇒
  • .collection(config) ⇒
  • .action(fn) ⇒
  • .batchAction(fn) ⇒
  • .batch(fn)
  • .preaction(fn) ⇒

.state(item) ⇒

Generate a Plexus State

Returns:

A Plexus State Instance

Param	Description
item	The default value to use when we generate the state

.computed(item) ⇒

Generate a Plexus State

Returns:

A Plexus State Instance

Param	Description
item	The default value to use when we generate the state

.event() ⇒

Create a new event Engine

Returns:

An Event Instance

.collection(config) ⇒

Create a new Collection Instance

Returns:

A collection Instance

Param	Description
config	The configuration for the collection

.action(fn) ⇒

Generate a Plexus Action

Returns:

The intended return value of fn, or null if an error is caught

Param	Description
fn	The Plexus action function to run

.batchAction(fn) ⇒

Generate a Plexus Action

Returns:

The intended return value of fn, or null if an error is caught

Param	Description
fn	The Plexus action function to run

.batch(fn)

Run a function. During that function's execution, any state changes will be batched and only applied once the function has finished.

Param	Description
fn	The function to run in a batch

.preaction(fn) ⇒

Generate a Plexus Action

Returns:

The intended return value of fn, or null if an error is caught

Param	Description
fn	The Plexus action function to run