feat(utils): getOnInit option for atomWithStorage (#2246)

docs/utilities/storage.mdx

@@ -41,6 +41,10 @@ The `atomWithStorage` function creates an atom with a value persisted in `localS
 - **removeItem(key)** (required): Deletes the item from storage
 - **subscribe(key, callback, initialValue)** (optional): A method which subscribes to external storage updates.
 
+**options** (optional): an object with the following properties:
+
+- **getOnInit** (optional): A boolean value indicating whether to get item from storage on initialization.
+
 If not specified, the default storage implementation uses `localStorage` for storage/retrieval, `JSON.stringify()`/`JSON.parse()` for serialization/deserialization, and subscribes to `storage` events for cross-tab synchronization.
 
 <CodeSandbox id="vuwi7" />

src/vanilla/utils/atomWithStorage.ts

@@ -122,7 +122,7 @@ export function atomWithStorage<Value>(
   key: string,
   initialValue: Value,
   storage: AsyncStorage<Value>,
-  unstable_options?: { unstable_getOnInit?: boolean },
+  options?: { getOnInit?: boolean },
 ): WritableAtom<
   Value | Promise<Value>,
   [SetStateActionWithReset<Value | Promise<Value>>],
@@ -133,7 +133,7 @@ export function atomWithStorage<Value>(
   key: string,
   initialValue: Value,
   storage?: SyncStorage<Value>,
-  unstable_options?: { unstable_getOnInit?: boolean },
+  options?: { getOnInit?: boolean },
 ): WritableAtom<Value, [SetStateActionWithReset<Value>], void>
 
 export function atomWithStorage<Value>(
@@ -142,9 +142,9 @@ export function atomWithStorage<Value>(
   storage:
     | SyncStorage<Value>
     | AsyncStorage<Value> = defaultStorage as SyncStorage<Value>,
-  unstable_options?: { unstable_getOnInit?: boolean },
+  options?: { getOnInit?: boolean },
 ): any {
-  const getOnInit = unstable_options?.unstable_getOnInit
+  const getOnInit = options?.getOnInit
   const baseAtom = atom(
     getOnInit
       ? (storage.getItem(key, initialValue) as Value | Promise<Value>)