archive-gh-me/zustand
1
0
Fork 0
mirror of https://github.com/pmndrs/zustand.git synced 2025-12-08 19:45:52 +00:00
Code Issues Projects Releases Wiki Activity

breaking(middleware): drop deprecated persist options and make removeItem required (#598)

Browse Source 
* breaking(middleware): drop deprecated persist options

* breaking(middleware): make persist options.removeItem required
This commit is contained in:
Daishi Kato 2022-04-07 23:43:39 +09:00 committed by GitHub
parent eadb81f9c6
commit 8c8f693999
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/middleware/persist.ts
View File

@ -7,8 +7,7 @@ type DeepPartial<T> = {
export type StateStorage = {
getItem: (name: string) => string | null | Promise<string | null>
setItem: (name: string, value: string) => void | Promise<void>
// Note: This will be required in v4
removeItem?: (name: string) => void | Promise<void>
removeItem: (name: string) => void | Promise<void>
}
type StorageValue<S> = { state: DeepPartial<S>; version?: number }
@ -44,18 +43,6 @@ export type PersistOptions<
deserialize?: (
str: string
) => StorageValue<PersistedState> | Promise<StorageValue<PersistedState>>
/**
* Prevent some items from being stored.
*
* @deprecated This options is deprecated and will be removed in the next version. Please use the `partialize` option instead.
*/
blacklist?: (keyof S)[]
/**
* Only store the listed properties.
*
* @deprecated This options is deprecated and will be removed in the next version. Please use the `partialize` option instead.
*/
whitelist?: (keyof S)[]
/**
* Filter the persisted value.
*
@ -189,14 +176,6 @@ export const persist =
...baseOptions,
}
if (options.blacklist || options.whitelist) {
console.warn(
`The ${
options.blacklist ? 'blacklist' : 'whitelist'
} option is deprecated and will be removed in the next version. Please use the 'partialize' option instead.`
)
}
let hasHydrated = false
const hydrationListeners = new Set<PersistListener<S>>()
const finishHydrationListeners = new Set<PersistListener<S>>()
@ -219,10 +198,6 @@ export const persist =
get,
api
)
} else if (!storage.removeItem) {
console.warn(
`[zustand persist middleware] The given storage for item '${options.name}' does not contain a 'removeItem' method, which will be required in v4.`
)
}
const thenableSerialize = toThenable(options.serialize)
@ -230,15 +205,6 @@ export const persist =
const setItem = (): Thenable<void> => {
const state = options.partialize({ ...get() })
if (options.whitelist) {
;(Object.keys(state) as (keyof S)[]).forEach((key) => {
!options.whitelist?.includes(key) && delete state[key]
})
}
if (options.blacklist) {
options.blacklist.forEach((key) => delete state[key])
}
let errorInSync: Error | undefined
const thenable = thenableSerialize({ state, version: options.version })
.then((serializedValue) =>
@ -342,7 +308,7 @@ export const persist =
}
},
clearStorage: () => {
storage?.removeItem?.(options.name)
storage?.removeItem(options.name)
},
rehydrate: () => hydrate() as Promise<void>,
hasHydrated: () => hasHydrated,