localstorage-a v0.0.1

Angular LocalStorage Library

This library provides a simple and flexible way to interact with the browser's localStorage, with optional encryption support for enhanced security.

Features

• Easy-to-use wrapper for localStorage operations
• Optional encryption for stored data
• TypeScript support
• Angular Injectable service

Installation

To install this library, run:

npm i @localstorage/localstorage-a

Usage

1. Import the library in your Angular application

In your app.config.ts (for standalone components) or app.module.ts:

import { provideLocalStorage } from "ngx-localstorage";

export const appConfig: ApplicationConfig = {
  providers: [
    // ... other providers
    ...provideLocalStorage({
      enckey: "YourOptionalEncryptionKey", // Optional: Provide an encryption key
    }),
  ],
};

2. Inject and use the LocalStorageService in your components

import { Component } from "@angular/core";
import { LocalStorageService } from "ngx-localstorage";

@Component({
  selector: "app-root",
  template: "...",
})
export class AppComponent {
  constructor(private localStorage: LocalStorageService) {
    // Save data
    this.localStorage.setItem("user", { name: "John Doe", age: 30 });

    // Retrieve data
    const user = this.localStorage.getItem("user");
    console.log(user); // { name: 'John Doe', age: 30 }

    // Remove data
    this.localStorage.removeItem("user");

    // Clear all data
    this.localStorage.clear();
  }
}

API

LocalStorageService

• setItem(key: string, value: any): void Saves data to localStorage. If an encryption key is provided, the data will be encrypted.

• getItem(key: string): any Retrieves data from localStorage. If an encryption key is provided, the data will be decrypted.

• removeItem(key: string): void Removes an item from localStorage.

• clear(): void Clears all data from localStorage.

provideLocalStorage

A function to provide the LocalStorageService with optional configuration:

provideLocalStorage({
  enckey: string, // Optional encryption key
});

Security Note

The encryption method used in this library is a simple implementation and may not be suitable for highly sensitive data. For production use with sensitive information, consider using a more robust encryption method.

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.