CHANGELOG.md

ng2-cache library Changelog

0.2.0

What changed

• Used angular-library-starter as base.
• Removed test cases related files from the base.
• Code comment updated at some places to avoid tslint errors. No implementation code is updated.
• To build, simple run npm run publish:lib. Files will be generated inside /dist folder as per Angular Package standard.
• To consume ng2-cache, nothing changes. Removed the need to import ng2-cache inside tsconfig.json

0.1.12

What changed

The library is created as separate Angular module.

After installing npm install ng2-cache --save

1. Import it in your main app module

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

2. Use it inside your Component by DI

   ...
   import { CacheService, CacheStoragesEnum } from 'ng2-cache';
   ...
   
   export class AppComponent {
   
   constructor(private _cacheService: CacheService) { 
       this._cacheService.set('key', ['some data']);
   } 
   

3. You might need to import it in yout tsconfig.json file

   "include": [
       "src/**/*",
       "node_modules/ng2-cache"
   ]
   

   You'll need to import the same way in your tsconfig.spec.json if you are running test cases with karma/jasmine.

0.1.11

ng2-cache

Client side caching service for Angular2

Installation

To install this library, run:

$ npm install ng2-cache --save

Usage:

import {Component} from '@angular/core';
import {CacheService, CacheStoragesEnum} from 'ng2-cache/ng2-cache';

declare var BUILD_VERSION: string;

@Component({
    selector: 'some-selector',
    template: '<div>Template</div>',
    providers: [ CacheService ]
})
export class ExampleComponent {

    constructor(private _cacheService: CacheService) {}

    public func() {

        //set global prefix as build version
        this._cacheService.setGlobalPrefix(BUILD_VERSION);

        //put some data to cache "forever"
        //returns true is data was cached successfully, otherwise - false
        let result: boolean = this._cacheService.set('key', ['some data']);

        //put some data to cache for 5 minutes (maxAge - in seconds)
        this._cacheService.set('key', ['some data'], {maxAge: 5 * 60});

        //put some data to cache for 1 hour (expires - timestamp with milliseconds)
        this._cacheService.set('key', {'some': 'data'}, {expires: Date.now() + 1000 * 60 * 60});

        //put some data to cache with tag "tag"
        this._cacheService.set('key', 'some data', {tag: 'tag'});
        
        //get some data by key, null - if there is no data or data has expired
        let data: any|null = this._cacheService.get('key');

        //check if data exists in cache
        let exists: boolean = this._cacheService.exists('key');

        //remove all data from cache with tag "tag"
        this._cacheService.removeTag('tag');

        //remove all from cache
        this._cacheService.removeAll();

        //get all data related to tag "tag" :
        // {'key' => 'key data', ...}
        this._cacheService.getTagData('tag');
        
        //change storage (returns new instance of service with needed storage)
        this._cacheService.useStorage(CacheStoragesEnum.LOCAL_STORAGE);

    }
}

By default service store data in session storage, you could select one of storages:

• session storage
• local storage
• memory

If current storage is not available - service will choose memory storage.

To change storage to local storage:

import {Component, provide} from 'angular2/core';
import {CacheService, CacheStorageAbstract, CacheLocalStorage} from 'ng2-cache/ng2-cache';

@Component({
    selector: 'some-selector',
    template: '<div>Template</div>',
    providers: [
        CacheService,
        {provide: CacheStorageAbstract, useClass:CacheLocalStorage}
    ]
})