historian.core — historian 1.2.1

Manage states for your atoms. (Easy undo/redo)

*record-active* clj/s

alexandria clj/s

The great library... store your stuff here.

can-redo? clj/s

(can-redo?)

Can we redo?

can-undo? clj/s

(can-undo?)

Do we have enough history to undo?

clear-history! clj/s

(clear-history!)

different-from? clj/s

(different-from? new old)

Check if any non-passive snapshot is different.

get-library-atom clj/s

(get-library-atom)

get-prophecy-atom clj/s

(get-prophecy-atom)

nostradamus clj/s

What will happen in the future...

off-the-record clj/s≠ macro

clj

(off-the-record & content)

cljs

(off-the-record &form &env & content)

Temporarily deactivate the watches write to history.

overseer clj/s

Who should we record?

overwrite-record! clj/s

(overwrite-record!)

(overwrite-record! snaps)

Overwrite the last historic entry with a new one.

record! clj/s

(record! atm k)

(record! atm k passive?)

Add the atom to the overseer watch. When any of the atom under its watch is modified, it triggers a save of every atom to history (if any of the atom is different form the last historic state). Return the atom.

If `passive?' is true, the atom will NOT trigger any new save and will only be saved when another atom under watch is modified.

redo! clj/s

(redo!)

replace-library! clj/s

(replace-library! new-atom)

The library atom (where all records are kept to enable 'undo') will be replaced by the new-atom. Useful if you've already done some modifications to the new-atom (like added some watchers). Depending on where you use this function, you might want to fire a `trigger-record!' just after.

Usually, one would also want to use `replace-prophecy!' in order to replace the 'redo' atom.

replace-prophecy! clj/s

(replace-prophecy! new-atom)

The prophecy atom (where all records are kept to enable 'redo') will be replaced by the new-atom. Useful if you've already done some modifications to the new-atom (like added some watchers).

Usually used with `replace-library'.

stop-all-records! clj/s

(stop-all-records!)

Remove all the atoms from the overseer watch. The atoms will no longer be watched, nor any of their state saved to history.

stop-record! clj/s

(stop-record! k)

Remove the atom associated to this key from the overseer watch. This atom will no longer be watched, nor its state saved to history.

take-snapshots clj/s

(take-snapshots)

trigger-record! clj/s

(trigger-record!)

Trigger a record to history. The current state of at least one atom must be different from the previous one for the record to be included into history.

undo! clj/s

(undo!)

with-single-before-and-after clj/s≠ macro

clj

(with-single-before-and-after & content)

cljs

(with-single-before-and-after &form &env & content)

Deactivate the watches write to history and execute the body. If any non-passive atom is modified, replace the last history with a snapshot taken just before executing the body and then take another snapshot.

with-single-record clj/s≠ macro

clj

(with-single-record & content)

cljs

(with-single-record &form &env & content)

Temporarily deactivate the watches write to history. A single write is triggered at the end of the macro, assuming at least one of the atoms watched by the overseer has changed.