Add info about getWritableSignal() to README.

e-oz · Nov 16, 2023 · 0e16b92 · 0e16b92
1 parent c7bb68a
commit 0e16b92
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+### v1.2.1
+Add info about `getWritableSignal()` to README.
+
 ### v1.2.0
 Method `getWritableSignal()` will not write initial value to the storage anymore.
 

diff --git a/README.md b/README.md
@@ -67,7 +67,19 @@ export type ReactiveStorage = {
    *
    * If localStorage is being used as the storage, the value will be pushed synchronously.
    */
-  getSignal<T>(key: string): Signal<T | undefined>;
+  getSignal<T>(key: string, options?: SignalOptions): Signal<T | undefined>;
+
+
+  /**
+   * Returns a signal with the current value for this key.
+   * The key becomes "observed" and future modifications will be
+   * written to the returned signal.
+   *
+   * The usage of the `set()` and `update()` methods of this signal will also update the storage key.
+   *
+   * If localStorage is being used as the storage, the value will be pushed synchronously.
+   */
+  getWritableSignal<T>(key: string, options?: SignalOptions): WritableSignal<T | undefined>;
 
   /**
    * Set a key-value pair

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ngx-reactive-storage",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "license": "MIT",
   "author": {
     "name": "Evgeniy OZ",

diff --git a/projects/ngx-reactive-storage/package.json b/projects/ngx-reactive-storage/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ngx-reactive-storage",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "license": "MIT",
   "private": false,
   "author": {