Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duart38/observe
Type-safe observable values (made with Deno)
https://github.com/duart38/observe
binding deno deno-module denoland event history javascript javascript-library livedata-databinding minimal no-dependencies observable observer state state-management state-pattern typesafe typescript
Last synced: 2 months ago
JSON representation
Type-safe observable values (made with Deno)
- Host: GitHub
- URL: https://github.com/duart38/observe
- Owner: duart38
- License: mit
- Created: 2020-07-27T21:48:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-16T14:55:58.000Z (almost 4 years ago)
- Last Synced: 2024-09-16T15:08:12.661Z (4 months ago)
- Topics: binding, deno, deno-module, denoland, event, history, javascript, javascript-library, livedata-databinding, minimal, no-dependencies, observable, observer, state, state-management, state-pattern, typesafe, typescript
- Language: TypeScript
- Homepage:
- Size: 245 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Observe
> **Simply observe any variable**
> 
[](https://nest.land/package/Observe)
## Example (Deno)
```JavaScript
let obs = new Observe("initial value"); // new observable with type String
obs.bind((data) => { // bind to receive updates on value change
// Do some stuff here (data here is of type string)
});
obs.setValue("another value"); // sets the value
obs.setValue("lorem", "ipsum", "dolor"); // sets the last value as active and emitting the other ones
console.log(obs.setValue("another value"))
```
Also check the examples folder for more examples
## Example (Basic html + js)
> Download Observe.js from the releases tab
**index.html**
```html
Observable value test
```
**index.js**
```JavaScript
var observable = new Observe("s")
observable.bind((d)=>{
console.log(d)
})
observable.setValue("new val")
```
## Methods
---
| Name | Description |
|---------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| getValue() | Returns the current value. To be used outside of callbacks |
| getHistory() | Gets the change history. Every time a new value is set it is pushed to a history array |
| bind() | used to listen to changes. Takes a callback method that is called with the new data when the observe instance changes. **Returns the function used for the event listener.. To be used with the unBind method (see below)** |
| unBind() | Unbinds a previously bound EventListener or EventListenerObject. The callback returned by bind() should be provided. Returns this |
| setValue() | Updates the observed value.. all bound will be notified. Setting a value equals to the last set value will do nothing. Returns the value that was passed in it (last value in case multiple) |
| stop() | Prevents event from reaching any registered event listeners after the current one. Returns this |
| reset() | Restore the state to the original provided method. Returns this |
| unBindAll() | Unbinds ALL previously bound EventListener or EventListenerObject. |
| maxHistorySize | Limit the history array size **(can be lowered to save some precious ram)** |
| getGlobalObservable | If opted in, receives the instance created that was attached to the JS window |
> The history length is limited to 1000 values.. after this the first value (excluding the original) will be removed on each push.. to increase or decrease this value change the "maxHistorySize" variable
See JSdoc for more information
### It is recommended to lower the value of maxHistorySize if you are not going to use the history.
## Testing
```Shell
deno test
```