Home

Awesome

atom-store

Circle CI

API

createAtom(val[, plugin]) => AtomInstance

Creates a new atom instance.

Arguments

An interface for external persistence

Your atom doesn't necessarily have to be referenced in memory. You can define your own interface into any external persistence type, through the optional plugin function. For example, Web Storage API's Storage interface, for which a plugin is already defined.

It must return two methods - write and read. These provide the transactional semantics between the defined store and the consumer application that invokes the mutations.

AtomInstance API

.read()

Returns the current atom value.

.write(fn(currentValue) {}, ...context)

Replaces the current atom value with the return value of the fn invocation. You may also optionally provide any number of context arguments, which will be appended to .watch invocations.

Arguments

.watch(fn(nextValue, prevValue, ...context) {})

Invokes the given function whenever the atom value changes. Also provides any context arguments that were handed off by the initiating .write call.

Arguments