这是indexloc提供的服务，不要输入任何密码
Skip to content

Feat/synchronize windows #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Feat/synchronize windows #72

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa7594c
feat: use storage events to synchronize across windows
OwenDelahoy Feb 6, 2023
dcc1bce
feat: allow configuration of how to add and remove StorageEvent liste…
OwenDelahoy Feb 6, 2023
f9232d2
fix: allow addStorageListener to be null to disable synchronization
OwenDelahoy Feb 6, 2023
a939c93
Merge branch 'master' into feat/synchronize-windows
OwenDelahoy Dec 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 35 additions & 4 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,15 @@ export interface PersistConverter {
parse: (value: string) => any
}

export interface StorageEvent {
readonly key?: string | null;
readonly newValue?: string | null;
}

export interface PersistConfiguration {
key?: string
storage?: PersistStorage
addStorageListener?: ((listener: (e: StorageEvent) => void) => ReturnType<AtomEffect<any>>) | null
converter?: PersistConverter
}

Expand All @@ -23,6 +29,9 @@ export interface PersistConfiguration {
* @param config Optional configuration object
* @param config.key Used as key in local storage, defaults to `recoil-persist`
* @param config.storage Local storage to use, defaults to `localStorage`
* @param config.addStorageListener Optional method to listen to storage events
* enabling external events to trigger application updates
* defaults to `localStorage` events synchronizing multiple windows
*/
export const recoilPersist = (
config: PersistConfiguration = {},
Expand All @@ -33,9 +42,17 @@ export const recoilPersist = (
}
}

const { key = 'recoil-persist', storage = localStorage, converter = JSON } = config
const {
key = 'recoil-persist',
storage = localStorage,
converter = JSON,
addStorageListener = (listener) => {
window.addEventListener('storage', listener)
return () => window.removeEventListener('storage', listener)
},
} = config

const persistAtom: AtomEffect<any> = ({ onSet, node, trigger, setSelf }) => {
const persistAtom: AtomEffect<any> = ({ onSet, node, trigger, setSelf, resetSelf }) => {
if (trigger === 'get') {
const state = getState()
if (typeof state.then === 'function') {
Expand All @@ -58,6 +75,20 @@ export const recoilPersist = (
updateState(newValue, state, node.key, isReset)
}
})

if(addStorageListener) {
const removeStorageListener = addStorageListener((e: StorageEvent) => {
if(e.key == key) {
const state = parseState(e.newValue)
if(node.key in state) {
setSelf(state[node.key])
} else {
resetSelf()
}
}
});
return removeStorageListener;
}
}

const updateState = (
Expand Down Expand Up @@ -90,8 +121,8 @@ export const recoilPersist = (
return {}
}

const parseState = (state: string) => {
if (state === undefined) {
const parseState = (state?: string | null) => {
if (!state) {
return {}
}
try {
Expand Down