You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
about: The issue tracker is not intended for support. A new GitHub "Discussions" tab, with a Questions & Answers category, is available for that purpose.
Copy file name to clipboardExpand all lines: README.md
+10-22
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,6 @@ Efficient client-side storage module for Angular:
8
8
-**compatibility**: works around some browsers issues and heavily tested via GitHub Actions,
9
9
-**documentation**: API fully explained, and a changelog!
10
10
11
-
## Status of this lib
12
-
13
-
Given my current professional situation and the lack of support for my open source work, this library is in a frozen state, meaning it is still available on npm but it will no longer get features updates or support.
14
-
15
11
## Why this module?
16
12
17
13
For now, Angular does not provide a client-side storage module, and almost every app needs some client-side storage.
@@ -46,18 +42,14 @@ ng add @ngx-builders/pwa-local-storage
46
42
*Done!*
47
43
48
44
You should **stick to these commands**. If for any reason `ng add` does not work,
49
-
be sure to follow the [manual installation guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/MANUAL_INSTALLATION.md),
45
+
be sure to follow the [manual installation guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/MANUAL_INSTALLATION.md),
50
46
as there are additionnal steps to do in addition to the package installation for some versions.
51
47
52
48
If you have multiple applications in the same project, as usual, you need to choose the project:
53
49
```bash
54
50
ng add @ngx-builders/pwa-local-storage --project yourprojectname
55
51
```
56
52
57
-
### Upgrading
58
-
59
-
To update to new versions, see the **[migration guides](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/MIGRATION.md).**
60
-
61
53
## API
62
54
63
55
```typescript
@@ -114,7 +106,7 @@ You can store any value, without worrying about serializing. But note that:
114
106
- storing `null` or `undefined` makes no sense and can cause issues in some browsers, so the item will be removed instead,
115
107
- you should stick to JSON data, ie. primitive types, arrays and *literal* objects.
116
108
`Date`, `Map`, `Set`, `Blob` and other special structures can cause issues in some scenarios.
117
-
See the [serialization guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/SERIALIZATION.md) for more details.
109
+
See the [serialization guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/SERIALIZATION.md) for more details.
**See the [full validation guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/VALIDATION.md) to see how to validate all common scenarios.**
156
+
**See the [full validation guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/VALIDATION.md) to see how to validate all common scenarios.**
See the [errors guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/ERRORS.md) for some details about what errors can happen.
185
+
See the [errors guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/ERRORS.md) for some details about what errors can happen.
194
186
195
187
### Expiration
196
188
197
189
This lib, as native `localStorage` and `indexedDb`, is about *persistent* storage.
198
190
199
191
Wanting *temporary* storage (like `sessionStorage`) is a very common misconception:
200
-
an application doesn't need that. [More details here](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/EXPIRATION.md).
192
+
an application doesn't need that. [More details here](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/EXPIRATION.md).
201
193
202
194
### `Map`-like operations
203
195
@@ -207,30 +199,26 @@ this lib also provides a `Map`-like API for advanced operations:
207
199
-`.has(key)`
208
200
-`.size`
209
201
210
-
See the [documentation](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/MAP_OPERATIONS.md) for more info and some recipes.
202
+
See the [documentation](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/MAP_OPERATIONS.md) for more info and some recipes.
211
203
For example, it allows to implement a multiple databases scenario.
212
204
213
205
## Support
214
206
215
207
### Browser support
216
208
217
209
This lib supports [the same browsers as Angular](https://angular.io/guide/browser-support).
218
-
See [the browsers support guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/BROWSERS_SUPPORT.md) for more details and special cases (like private browsing).
210
+
See [the browsers support guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/BROWSERS_SUPPORT.md) for more details and special cases (like private browsing).
219
211
220
212
### Collision
221
213
222
214
If you have multiple apps on the same *sub*domain *and* you don't want to share data between them,
223
-
see the [prefix guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/COLLISION.md).
215
+
see the [prefix guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/COLLISION.md).
224
216
225
217
### Interoperability
226
218
227
219
For interoperability when mixing this lib with direct usage of native APIs or other libs like `localForage`
228
220
(which doesn't make sense in most cases),
229
-
see the [interoperability documentation](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/INTEROPERABILITY.md).
230
-
231
-
### Changelog
232
-
233
-
[Changelog available here](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/CHANGELOG.md), and [migration guides here](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/MIGRATION.md).
221
+
see the [interoperability documentation](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/INTEROPERABILITY.md).
0 commit comments