reactive-objects v0.0.3

Reactive Objects

Reactive Objects is a simple class wrapper for your TypeScript objects that allows objects to trigger side effects on normal data changes or access. Simply initialize your object as a reactive object. Register your side effect functions, then simply access and reassign values as usual with side effects to follow.

Usage

import { ReactiveObject } from 'reactive-object';

const foo: any = new ReactiveObject({});
foo.registerEffect(() => console.log('bar'));

// should log 'bar'.
foo.bar = 'hello world';

Effects can be registered and removed.

const foo: any = new ReactiveObject({]);
const hash = foo.registerEffect(() => console.log('hello'));
foo.removeEffect(hash);

// should not log 'hello'
foo.bar = 'baz';

Add a getter effect (for example, a logger for property access).

const foo: any = new ReactiveObject({ bar: 'baz' });
foo.registerEffect(({ key }: GetEffectArguments ) => console.log(key), 'get');

// should log 'bar'
foo.bar;

The library guards against infinite loops. The following effect will not execute.

const foo: any = new ReactiveObject({ bar: 'baz' });
// would blow out the call stack... but will not execute.
foo.registerEffect(({ key }: GetEffectArguments) => console.log(foo[key]), 'get');

// nothing happens.
foo.bar;