summaryrefslogtreecommitdiff
path: root/packages/web-util/src/hooks/useMemoryStorage.ts
blob: ef186392f58591d386d224e7be97012e41bfb501 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
 This file is part of GNU Anastasis
 (C) 2021-2022 Anastasis SARL

 GNU Anastasis is free software; you can redistribute it and/or modify it under the
 terms of the GNU Affero General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Anastasis is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along with
 GNU Anastasis; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

/**
 *
 * @author Sebastian Javier Marchano (sebasjm)
 */

import { useEffect, useState } from "preact/hooks";
import { ObservableMap, memoryMap } from "../utils/observable.js";
import { StorageKey, StorageState } from "./useLocalStorage.js";

const storage: ObservableMap<string, any> = memoryMap<any>();

//with initial value
export function useMemoryStorage<Type = string>(
  key: string,
  defaultValue: Type,
): Required<StorageState<Type>>;
//with initial value
export function useMemoryStorage<Type = string>(
  key: string,
): StorageState<Type>;
// impl
export function useMemoryStorage<Type = string>(
  key: string,
  defaultValue?: Type,
): StorageState<Type> {
  const [storedValue, setStoredValue] = useState<Type | undefined>(
    (): Type | undefined => {
      const prev = storage.get(key);
      return prev === undefined ? defaultValue : prev;
    },
  );

  useEffect(() => {
    return storage.onUpdate(key, () => {
      const newValue = storage.get(key);
      setStoredValue(newValue === undefined ? defaultValue : newValue);
    });
  }, [key]);

  const setValue = (value?: Type): void => {
    if (value === undefined) {
      storage.delete(key);
    } else {
      storage.set(key, value);
    }
  };

  return {
    value: storedValue,
    update: setValue,
    reset: () => {
      setValue(defaultValue);
    },
  };
}