Research
Security News
Threat Actor Exposes Playbook for Exploiting npm to Build Blockchain-Powered Botnets
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
@ngx-pwa/local-storage
Advanced tools
Efficient local storage module for Angular apps and PWA: simple API based on native localStorage API, but internally stored via the asynchronous IndexedDB API for performance, and wrapped in RxJS observables to be homogeneous with other Angular modules.
Efficient local storage module for Angular apps and Progressive Wep apps (PWA):
localStorage
API and automatic JSON stringify/parse,IndexedDB
API,Observables
,For now, Angular does not provide a local storage module, and almost every app needs some local storage. There are 2 native JavaScript APIs available:
The localStorage
API is simple to use but synchronous, so if you use it too often,
your app will soon begin to freeze.
The IndexedDB
API is asynchronous and efficient, but it's a mess to use:
you'll soon be caught by the callback hell, as it does not support Promises yet.
Mozilla has done a very great job with the localForage library:
a simple API based on native localStorage
,
but internally stored via the asynchronous IndexedDB
for performance.
But it's built in ES5 old school way and then it's a mess to include into Angular.
This module is based on the same idea as localForage, but in ES6 and additionally wrapped into RxJS Observables to be homogeneous with other Angular modules.
If you already use the previous angular-async-local-storage
package, or to update to version 6,
see the migration guide.
Install the same version as your Angular one via npm:
# For Angular 6:
npm install @ngx-pwa/local-storage@6
# For Angular 5:
npm install @ngx-pwa/local-storage@5
Then, for version 5 only, include the LocalStorageModule
in your app root module (just once, do NOT re-import it in your submodules). Since version 6, this step must be skipped, as LocalStorageModule
is removed.
import { LocalStorageModule } from '@ngx-pwa/local-storage';
@NgModule({
imports: [
BrowserModule,
LocalStorageModule,
...
]
...
})
export class AppModule {}
Now you just have to inject the service where you need it:
import { LocalStorage } from '@ngx-pwa/local-storage';
@Injectable()
export class YourService {
constructor(protected localStorage: LocalStorage) {}
}
The API follows the native localStorage API, except it's asynchronous via RxJS Observables.
let user: User = { firstName: 'Henri', lastName: 'Bergson' };
this.localStorage.setItem('user', user).subscribe(() => {});
You can store any value, without worrying about stringifying.
To delete one item:
this.localStorage.removeItem('user').subscribe(() => {});
To delete all items:
this.localStorage.clear().subscribe(() => {});
this.localStorage.getItem<User>('user').subscribe((user) => {
user.firstName; // should be 'Henri'
});
As any data can be stored, you can type your data.
Not finding an item is not an error, it succeeds but returns null
.
this.localStorage.getItem('notexisting').subscribe((data) => {
data; // null
});
Don't forget it's client-side storage: always check the data, as it could have been forged or deleted. Starting with version 5, you can use a JSON Schema to validate the data.
import { JSONSchema } from '@ngx-pwa/local-storage';
const schema: JSONSchema = {
properties: {
firstName: { type: 'string' },
lastName: { type: 'string' }
},
required: ['firstName', 'lastName']
};
this.localStorage.getItem<User>('user', { schema }).subscribe((user) => {
// Called if data is valid or null
}, (error) => {
// Called if data is invalid
});
Note: last draft of JSON Schema is used (draft 7 at this time),
but we don't support all validation features. Just follow the JSONSchema
interface or see #18 for the full list.
Note: as the goal is validation, types are enforced: each value MUST have either type
or properties
or items
or const
or enum
.
You DO NOT need to unsubscribe: the observable autocompletes (like in the HttpClient
service).
But you DO need to subscribe, even if you don't have something specific to do after writing in local storage (because it's how RxJS Observables work).
Since version 5.2, you can use these methods to auto-subscribe:
this.localStorage.setItemSubscribe('user', user);
this.localStorage.removeItemSubscribe('user');
this.localStorage.clearSubscribe();
Use these methods only if these conditions are fulfilled:
localStorage
and IndexedDB
are restricted to the same subdomain, so no risk of collision in most cases.
Only if you have multiple apps on the same subdomain and you don't want to share data between them, add a prefix:
import { localStorageProviders } from '@ngx-pwa/local-storage';
@NgModule({
providers: [
localStorageProviders({ prefix: 'myapp' })
]
})
export class AppModule {}
this.localStorage.setItem('color', 'red').subscribe(() => {
// Done
}, () => {
// Error
});
This lib major version is aligned to the major version of Angular. Meaning for Angular 5 you need version 5, for Angular 6 you need version 6, and so on.
We follow Angular LTS support, meaning we support Angular 5 minimum, until May 2019.
This module supports AoT pre-compiling.
This module supports Universal server-side rendering via a mock storage.
All browsers supporting IndexedDB, ie. all current browsers : Firefox, Chrome, Opera, Safari, Edge, and IE10+.
Local storage is required only for apps, and given that you won't do an app in older browsers, current browsers support is far enough.
Even so, IE9 is supported but use native localStorage as a fallback, so internal operations are synchronous (the public API remains asynchronous-like).
This module is not impacted by IE/Edge missing IndexedDB features.
It also works in tools based on browser engines (like Electron) but not in non-browser tools (like NativeScript, see #11).
Be aware that local storage is limited in browsers when in private / incognito modes. Most browsers will delete the data when the private browsing session ends. It's not a real issue as local storage is useful for apps, and apps should not be in private mode.
In some scenarios, indexedDB
is not available, so the lib fallbacks to (synchronous) localStorage
. It happens in:
MIT
7.4.1 (2019-01-27) / 5.3.6 and 6.2.3 and 7.4.2 (2019-02-25)
type
in every JSON schema, especially type: 'array'
and type: 'object'
which were optional but will be required in v8JSONSchema
interface (v7 only)null
in JSON schemaslocalStorageProviders()
for configuration instead of LOCAL_STORAGE_PREFIX
FAQs
Efficient local storage module for Angular: simple API based on native localStorage API, but internally stored via the asynchronous IndexedDB API for performance, and wrapped in RxJS observables to be homogeneous with other Angular modules.
The npm package @ngx-pwa/local-storage receives a total of 12,417 weekly downloads. As such, @ngx-pwa/local-storage popularity was classified as popular.
We found that @ngx-pwa/local-storage demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.