Skip to content

Commit

Permalink
Update readme for resetState()
Browse files Browse the repository at this point in the history
  • Loading branch information
Dan Wahlin authored and Dan Wahlin committed Feb 29, 2020
1 parent 07843fb commit 8e3bcec
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md → modules/observable-store/README copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ Observable Store provides a simple API that can be used to get/set state, subscr
| `setState(state: T, action: string, dispatchState: boolean = true) : T` | Set the store state. Pass the state to be updated as well as the action that is occuring. The state value can be a function (see example below). The latest store state is returned and any store subscribers are notified of the state change. The dispatchState parameter can be set to `false` if you do not want to send state change notifications to subscribers.
| `static addExtension(extension: ObservableStoreExtension)` | Used to add an extension into ObservableStore. The extension must implement the `ObservableStoreExtension` interface.
| `static initializeState(state: any)` | Used to initialize the store's state. An error will be thrown if this is called and store state already exists so this should be set when the application first loads. No notifications are sent out to store subscribers when the store state is initialized.
| `static resetState(state)` | Used to reset the state of the store to a desired value for all services that derive from ObservableStore<T>. A state change notification and global state change notification is sent out to subscribers if the dispatchState parameter is true (the default value).
| `static resetState(state, dispatchState: boolean = true)` | Used to reset the state of the store to a desired value for all services that derive from ObservableStore<T>. A state change notification and global state change notification is sent out to subscribers if the dispatchState parameter is true (the default value).
<br>

Properties | Description
Expand Down
2 changes: 1 addition & 1 deletion modules/observable-store/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ Observable Store provides a simple API that can be used to get/set state, subscr
| `setState(state: T, action: string, dispatchState: boolean = true) : T` | Set the store state. Pass the state to be updated as well as the action that is occuring. The state value can be a function (see example below). The latest store state is returned and any store subscribers are notified of the state change. The dispatchState parameter can be set to `false` if you do not want to send state change notifications to subscribers.
| `static addExtension(extension: ObservableStoreExtension)` | Used to add an extension into ObservableStore. The extension must implement the `ObservableStoreExtension` interface.
| `static initializeState(state: any)` | Used to initialize the store's state. An error will be thrown if this is called and store state already exists so this should be set when the application first loads. No notifications are sent out to store subscribers when the store state is initialized.
| `static resetState(state)` | Used to reset the state of the store to a desired value for all services that derive from ObservableStore<T>. A state change notification and global state change notification is sent out to subscribers if the dispatchState parameter is true (the default value).
| `static resetState(state, dispatchState: boolean = true)` | Used to reset the state of the store to a desired value for all services that derive from ObservableStore<T>. A state change notification and global state change notification is sent out to subscribers if the dispatchState parameter is true (the default value).
<br>

Properties | Description
Expand Down

0 comments on commit 8e3bcec

Please sign in to comment.