README.md
[//]: #@corifeus-header
[](https://www.npmjs.com/package/p3x-angular-http-cache-interceptor/)
[](https://paypal.me/patrikx3) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software) [](https://github.com/patrikx3/angular-http-cache-interceptor/actions?query=workflow%3Abuild)
[](https://stats.uptimerobot.com/9ggnzcWrw)
# 🔥 Cache every request in Angular, not only the GET, but all methods of this interceptor, and allows you to interact with the interceptor via specific headers and modify the request, and these specific headers will be not included in the final request v2023.10.126
**Bugs are evident™ - MATRIX️**
### NodeJS LTS is supported
### Built on NodeJs version
```txt
v20.5.0
```
# Built on Angular
```text
16.1.7
```
# Description
[//]: #@corifeus-header:end
<!--
Based on [@d4h/angular-http-cache](https://www.npmjs.com/package/@d4h/angular-http-cache), but it works without any configuration and a different implementation, so they are not the same at all, but the idea is the same.
-->
Usually, when you want to cache all requests, you do not cache all requests, but only the `GET` method. But, for some frontend applications, it is required to cache everything, otherwise the subsequent requests, without cache, would slow down the application flow. So, this micro-service caches all method/path/query variables/parameters/request body.
The way, we can find out what we are caching it is not simple. Usually, you would cache by a key of the `httpRequest.urlWithParams` and only the `GET` HTTP method.
To create this cache key, this package is using the `object-hash` package, with the following algorithm:
```ts
import * as hash from 'object-hash'
const hashOptions = {
algorithm: 'md5',
encoding: 'hex'
}
httpToKey(httpRequest: HttpRequest<any>) {
const key = httpRequest.method + '@' + httpRequest.urlWithParams + '@' + hash(httpRequest.params, hashOptions) + '@' + hash(httpRequest.body, hashOptions)
return key
}
```
There is room in the future, to restrict to specific methods and add more configurations and functions. If there is a need for this micro-service, it could be enhanced, but for now, it is caching everything, with the exception, when you include the `CachingHeaders.NoCache` header into your request, then this request will always hit the server.
# Example web page that uses this package
https://angular-http-cache-interceptor.corifeus.com
# How to use it
```bash
npm i p3x-angular-http-cache-interceptor object-hash
```
## Include the caching interceptor into your Angular module
```ts
import { NgModule } from '@angular/core';
import { P3XHttpCacheInterceptorModule } from 'p3x-angular-http-cache-interceptor';
@NgModule({
declarations: [
],
imports: [
P3XHttpCacheInterceptorModule,
],
providers: [
],
bootstrap: []
})
export class SomeModule { }
```
### Options
```ts
import { P3XHttpCacheInterceptorModule, CachingHeaders, CachingStore } from 'p3x-angular-http-cache-interceptor';
P3XHttpCacheInterceptorModule.forRoot({
// default request is no cache
behavior: CachingHeaders.NoCache,
// if a request has CachingHeaders.Cache header it will cache globally
store: CachingStore.Global,
})
P3XHttpCacheInterceptorModule.forRoot({
// default request is cache
behavior: CachingHeaders.Cache,
// in this config, it will cache not globally, but per module
store: CachingStore.PerModule,
})
```
## Example invocation in a component
With and without cache:
```ts
import { Component } from '@angular/core';
import { HttpClient } from "@angular/common/http";
import {MatSnackBar} from "@angular/material/snack-bar";
import { CachingHeaders } from 'p3x-angular-http-cache-interceptor'
@Component({
selector: 'p3x-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.scss']
})
export class AppComponent {
constructor(
private http: HttpClient,
private snack: MatSnackBar,
) {
}
async loadCached() {
try {
const response : any = await this.http.get('https://server.patrikx3.com/api/core/util/random/32').toPromise()
this.snack.open(`Will be always the same: ${response.random}`, 'OK')
} catch(e) {
this.snack.open(`Sorry, error happened, check the console for the error`, 'OK')
console.error(e)
}
}
async loadNonCached() {
try {
const response : any = await this.http.get('https://server.patrikx3.com/api/core/util/random/32', {
headers: {
[CachingHeaders.NoCache]: '1'
}
}).toPromise()
this.snack.open(`Truly random data: ${response.random}`, 'OK')
} catch(e) {
this.snack.open(`Sorry, error happened, check the console for the error`, 'OK')
console.error(e)
}
}
}
```
[//]: #@corifeus-footer
---
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
All my domains ([patrikx3.com](https://patrikx3.com) and [corifeus.com](https://corifeus.com)) could have minor errors, since I am developing in my free time. However, it is usually stable.
**Note about versioning:** Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
---
[**P3X-ANGULAR-HTTP-CACHE-INTERCEPTOR**](https://corifeus.com/angular-http-cache-interceptor) Build v2023.10.126
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software)
[//]: #@corifeus-footer:end
