Interface LiveFunction

The object returned by cjs.liven.

interface LiveFunction {
    _constraint: Constraint;
    destroy(silent?: boolean): void;
    invalidate(): void;
    pause(): boolean;
    resume(): boolean;
    run(): LiveFunction;
}

Index

Properties

Methods

destroy invalidate pause resume run

Properties

`Readonly`_constraint

_constraint: Constraint

The constraint that tracks the function's dependencies (for debugging).

Methods

destroy

destroy(silent?: boolean): void
Stop running the function and clean up.
Parameters
- Optionalsilent: boolean
Returns void
- Defined in liven.ts:24

invalidate

invalidate(): void
Mark the function as needing to re-run (which it does right away, unless paused).

Returns void
- Defined in liven.ts:32

pause

pause(): boolean
Stop re-running the function until resume is called. Returns false if it was already paused.

Returns boolean
- Defined in liven.ts:26

resume

resume(): boolean
Start re-running the function again (running it now if anything changed). Returns false if it wasn't paused.

Returns boolean
- Defined in liven.ts:28

run

run(): LiveFunction
Run the function now if anything it depends on has changed.

Returns LiveFunction
- Defined in liven.ts:30