https://github.com/magnusthor/thor-rx
ThorRx is a tiny Proxy based lib for deliverering events and change records to keep track of mutations.
https://github.com/magnusthor/thor-rx
Last synced: 7 months ago
JSON representation
ThorRx is a tiny Proxy based lib for deliverering events and change records to keep track of mutations.
- Host: GitHub
- URL: https://github.com/magnusthor/thor-rx
- Owner: MagnusThor
- License: mit
- Created: 2017-03-22T13:02:09.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-10T11:41:30.000Z (about 9 years ago)
- Last Synced: 2025-02-05T09:38:54.529Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# thor-rx
ThorRx is a tiny Proxy based lib for
deliverering events and change records to keep track of mutations on objects (models).
When a property is modified on an thor-rx 'observed' instance
thor-rx will deliver change notifications
that helps you keep track of changes in a smooth way.
## Installation
npm install thor-rx
# Documentation
Below follows a brief documentation.
## ThorRx<T extends ThorRxBase >(obj:any, (changes:ChangeModel) =>void):ThorRx<T>
Create a new thor-rx observer
let rx = new ThorRx(instance,(changes:ChangeModel) => {});
### getObserver():T
Get a thor-rx instance of type T. T is the proxied instances of yours.
observerOfT = rx.getObserver();
#### example
Where we have an object(Model) Person
let person = new Person();
let rx = new ThorRx(person , (changes:ChangeModel) => {
// do op with changes
});
let rxPerson= rx.getObserver();
// rx person is now a observed (Proxied) instance of Person
## ChangeModel
Change model contains information about the current change.
class ChangeModel {
target: any;
type: string;
newValue: any;
oldValue: any;
timeStamp: Date;
constructor(target: any, type: string, newValue: any, oldValue: any);
}
### Change type's
An change type can be as follows: add, removed and update.
add and remove relates to Array properties.
## ThorRxBase
The objects you wich to observe must derive (extends) from
ThorRxBase.
class MyModel extends ThorRxBase{
constructor(){
super();
..
}
}
### observe(target:any) : void
Make an property / target of the class that derives from ThorRxBase
an observable. Will report changes when modified
### unobserve(target:any): void
Makes a properry ( target) a non observable. Will not report changes when modified
# Decorators
Decorators lets you by decorating properties of your objects(classes)
gain control of what attributes that thor-rx captures mutations on.
By default the property is observed.
### @Observe(isObserve:boolean)
if an @Observe decorator exists on a property , you can control it
by settig isObserve:boolean to true/false, if fn:Function is
defined fn will be the Fn to be called on property mutations.
Note: will not affect newable properties. See observe and unobserve above.
#### example
class Person{
@Observe(false) fullName:string;
@Observe(true) age:number
...
}
# Example ( Quick guide )
The example below creates an thor-rx observer for Person (class)
let personObserver = new ThorRx(new Person(), (change:ChangeModel) => {
// do op's with the change
});
Where person look needs to extend ThorRxBase such as
class Person extends ThorRxBase {
fullName:string
constructor(){
super();
}
}
To get an observer instance you need to call .getObserver():T such as below.
let personObserver = new ThorRx(new Person(),(change:ChangeModel) => {
// do op's with the change
});
let person = personObserver.getObserver()
person.fullName = "Sven Erik Magnusson";
Setting the property .fullName will deliver (fire) the changes
handler you provded , in this example
(change:ChangeModel) => {
// do op
}
# Roadmap / Todo
-