NgMemento

ng-memento makes your application faster by preventing the same http requests from being called again in your Angular project.

Installation

npm i ng-memento --save

Demo

Example

The application was built by using this library. Visit

Image

Stable Versions

| Angular version | ng-memento version | | :-------------- | :----------------- | | v13.x.x | v3.x.x | | v14.x.x | v4.x.x | | v15.x.x | v5.x.x | | v16.x.x | v6.x.x | | v17.x.x | v7.x.x | | v18.x.x | v8.x.x | | v19.x.x | v9.x.x | | v20.x.x | v10.x.x |

Documentation

How can I use?

import { NgMementoModule, IMementoConfig } from "ng-memento";

const config: IMementoConfig = {
  expireTimeAsMilliSeconds: 60 * 60 * 1000, // an hour
  store: 'local',
  storeKey: 'MEMENTO_KEY',
  paths: [
    {
      methods: ["GET", "POST"],
      path: "comments/*",
      store: "session",
    },
    {
      methods: ["GET"],
      path: "users/1",
      storeKey: "MEMENTO_USERS_2",
      expireTimeAsMilliSeconds: 24 * 60 * 60 * 1000, // a day

    },
    {
      methods: ["GET"],
      path: "users/2",
      storeKey: "MEMENTO_USERS_2",
      expireTimeAsMilliSeconds: 24 * 60 * 60 * 1000, // a day
    },
    {
      methods: ["GET"],
      path: "users/*",
      storeKey: "MEMENTO_USERS",
    },
    {
      methods: ["GET"],
      path: "posts",
      store: "none",
    },
  ],
};

/* MODULE-BASED ARCHITECTURE */
@NgModule({
  declarations: [],
  imports: [
    ...,
    NgMementoModule.forRoot(config),
  ],
  providers: [],
  bootstrap: [],
})
export class AppModule {}

/* STANDALONE ARCHITECTURE */
export const appConfig: ApplicationConfig = {
  providers: [
    ...,
    importProvidersFrom(
      NgMementoModule.forRoot(config),
    ),
  ],
};

Types

IMementoConfig

| property | type | default | required | description | | :------------------------- | :------------------------- | :------------ | :------- | :----------------------------------------------------- | | expireTimeAsMilliSeconds | number | | ✓ | cached data stored time | | paths | IMethodPath | | ✓ | | | store | none, local, session | none | x | none: cached data stored lives only until next refresh | | storeKey | string | MEMENTO_KEY | x | key that stores data if chose local or session |

IMethodPath

| property | type | default | required | description | | :------------------------- | :------------------------- | :----------- | :------- | :--------------------------------------------------------------------------- | | methods | MethodType | | ✓ | methods to be cached | | path | string | | ✓ | path to be cached (if path ends with '/*' all sub paths will be cached) | | expireTimeAsMilliSeconds | number | parent value | x | cached data stored time | | store | none, local, session | parent value | x | none: cached data stored lives only until next refresh | | storeKey | string | parent value | x | key that stores data if chose local or session |

MethodType

| property | type | default | required | description | | :----------- | :------------------------------ | :------ | :------- | :------------------- | | MethodType | "GET", "POST", "PUT", "PATCH" | | ✓ | methods to be cached |

Important

You should use MethodType carefully. You send same header, body, params and path when you use POST, PUT and PATCH method, ng-memento will prevent the request therefore the data will not affect.