@bi8/am-storage

AmStorage is a simple framework for saving and loading information from *localStorage*.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
01Sep 4, 2020Aug 6, 2017Minified + gzip package size for @bi8/am-storage in KB

Readme

Angular Material Storage

AmStorage is a simple framework for saving and loading information from localStorage.

Please note that this is a Proof of Concept library and not meant for production use and that the API can change at any time.

Version 5.0 is a update to the way the library gets build as well as depending on Angular5.

This project was generated with Angular CLI version 1.5.0.

Installation

To install AmStorage in your project, simply do

npm i @bi8/am-storage

Configuration

Import the AmStorageModule

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

import { AmLoggerModule } from "./modules/am-logger/am-logger.module";
import { LogLevel } from "./modules/am-logger/log-level.enum";
import { LogConfig } from "./modules/am-logger/log-config";

import { AmStorageModule } from "@bi8/am-storage";

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AmStorageModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Build

Run npm i to install all the dependencies. To create the bundle/distribution, run npm run packagr which will do a new release under the dist folder.

Project Layout

This is basically a CLI generated application with the addition of ng-packagr to create the distribution bundle. The app component imports the AmStorageModule that is located under the modules directory. Only the module is packaged an not the whole example project.

Please see Nikolas LeBlanc's article: Building an Angular 4 Component Library with the Angular CLI and ng-packagr

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.