From be015e8b9f5df2f0a8ab7288a7024728dafeface Mon Sep 17 00:00:00 2001 From: duart38 Date: Sat, 5 Sep 2020 00:04:02 +0200 Subject: [PATCH] Updated README --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5bde8d8..b39857d 100644 --- a/README.md +++ b/README.md @@ -52,10 +52,11 @@ observable.setValue("new val") | 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 | +| 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)** | > 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