@esfaenza/preferences 11.2.14 → 11.2.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,6 +10,10 @@ export declare class PreferencesService {
10
10
  * Store in memoria delle preferenze locali che sarà persistito per mezzo della classe che fa le veci del **BasePreferencesPersistor**
11
11
  */
12
12
  private LocalPreferences;
13
+ /**
14
+ * Indica le chiavi contenute in **LocalPreferences** di che tipo sono in modo da ripulire correttamente sulla clear
15
+ */
16
+ private LocalPreferenceType;
13
17
  /**
14
18
  * Costruttore
15
19
  *
@@ -17,36 +21,21 @@ export declare class PreferencesService {
17
21
  */
18
22
  constructor(persistor: BasePreferencesPersistor, PREF_FULL_RETRIEVE_AT_START: boolean);
19
23
  /**
20
- * Salva un oggetto solo nella cache locale. Dovrà essere persistito manualmente o andrà perso al riavvio dell'applicazione
24
+ * Salva un oggetto sia nella cache locale che nel persistor
21
25
  *
22
26
  * @param {string} key Chiave di persistenza
23
27
  * @param {T} item Oggetto da salvare
28
+ * @param {'cache' | 'preference'} storeLevel Livello a cui storicizzare l'oggetto. Utilizzare **cache** per cose salvate dall'applicazione, utilizzare **preference** per cose salvate dall'utente
24
29
  */
25
- storeLocal<T>(key: string, item: T): boolean;
26
- /**
27
- * Recupera un oggetto in base a una chiave. Permette di accedere solo alla copia locale
28
- *
29
- * @param {string} key Chiave del valore da recuperare
30
- * @param {boolean} cacheBust Indica se ignorare il valore della cache locale e recuperare l'oggetto dallo store persistito,
31
- * in caso fosse stato modificato fuori sistema o da un altro sistema
32
- *
33
- * @returns {T} Oggetto richiesto
34
- */
35
- retrieveLocal<T>(key: string, cacheBust?: boolean): T;
36
- /**
37
- * Ripulisce le impostazioni locali e le impostazioni salvate dal persistor
38
- *
39
- * @param {'cache' | 'preference'} storeLevel Livello a cui ripulire la cache. Utilizzare **cache** per cancellare cose salvate dall'applicazione, utilizzare **preference** per cancellare cose salvate dall'utente
40
- */
41
- clear(storeLevel: 'cache' | 'preference'): Observable<boolean>;
30
+ setItem<T>(key: string, item: T, storeLevel?: 'cache' | 'preference'): Observable<boolean>;
42
31
  /**
43
- * Salva un oggetto sia nella cache locale che nel persistor
32
+ * Salva un oggetto solo nella cache locale. Dovrà essere persistito manualmente o andrà perso al riavvio dell'applicazione
44
33
  *
45
34
  * @param {string} key Chiave di persistenza
46
35
  * @param {T} item Oggetto da salvare
47
36
  * @param {'cache' | 'preference'} storeLevel Livello a cui storicizzare l'oggetto. Utilizzare **cache** per cose salvate dall'applicazione, utilizzare **preference** per cose salvate dall'utente
48
37
  */
49
- store<T>(key: string, item: T, storeLevel: 'cache' | 'preference'): Observable<boolean>;
38
+ setLocalItem<T>(key: string, item: T, storeLevel?: 'cache' | 'preference'): boolean;
50
39
  /**
51
40
  * Salva, per una sessione, una chiave con un valore, viene chiamato automaticamente dal metodo **store** ma dev'essere chiamato manualmente
52
41
  * nel caso si utilizzi il metodo **storeLocal**
@@ -54,7 +43,7 @@ export declare class PreferencesService {
54
43
  * @param {string} key Chiave da storicizzare
55
44
  * @param {'cache' | 'preference'} storeLevel Livello a cui storicizzare l'oggetto. Utilizzare **cache** per cose salvate dall'applicazione, utilizzare **preference** per cose salvate dall'utente
56
45
  */
57
- persist<T>(key: string, item: T, storeLevel: 'cache' | 'preference'): Observable<boolean>;
46
+ private persist;
58
47
  /**
59
48
  * Recupera un oggetto in base a una chiave. Permette di accedere alla copia locale o alla copia persistita.
60
49
  *
@@ -64,5 +53,25 @@ export declare class PreferencesService {
64
53
  *
65
54
  * @returns {T} Oggetto richiesto
66
55
  */
67
- retrieve<T>(key: string, cacheBust?: boolean): Observable<T>;
56
+ getItem<T>(key: string, cacheBust?: boolean): Observable<T>;
57
+ /**
58
+ * Recupera un oggetto in base a una chiave. Permette di accedere solo alla copia locale
59
+ *
60
+ * @param {string} key Chiave del valore da recuperare
61
+ *
62
+ * @returns {T} Oggetto richiesto
63
+ */
64
+ getLocalItem<T>(key: string): T;
65
+ /**
66
+ * Elimina un oggetto dalla cache sia locale che persistita
67
+ *
68
+ * @param {string} key Chiave da rimuovere
69
+ */
70
+ removeItem(key: string): Observable<boolean>;
71
+ /**
72
+ * Ripulisce le impostazioni locali e le impostazioni salvate dal persistor
73
+ *
74
+ * @param {'cache' | 'preference'} storeLevel Livello a cui ripulire la cache. Utilizzare **cache** per cancellare cose salvate dall'applicazione, utilizzare **preference** per cancellare cose salvate dall'utente
75
+ */
76
+ clear(storeLevel: 'cache' | 'preference' | 'all'): Observable<boolean>;
68
77
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@esfaenza/preferences",
3
- "version": "11.2.14",
3
+ "version": "11.2.18",
4
4
  "dependencies": {
5
5
  "tslib": "^2.0.0"
6
6
  },