ngx-api-cache 20.0.1 → 20.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sokolov Andrey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,7 +4,7 @@ This project was generated using [Angular CLI](https://github.com/angular/angula
 
 ## Description
 
-This is a very lightweight library for vertical scrolling. 
+This is a very lightweight library for api-cache.
 
 This library does not require third party dependencies
 
@@ -13,7 +13,7 @@ This library does not require third party dependencies
 1. Install
 
    ```bash
-   npm i ngx-api-cache or 
+   npm i ngx-api-cache 
    ```
    OR
 
@@ -21,24 +21,80 @@ This library does not require third party dependencies
    yarn add ngx-api-cache
    ```
 
-2. Import to your component or module this component:
+2. Provide HttpClient to your App:
 
    ```bash
-   NgxScrollbarUltimateComponent
+   import { provideHttpClient } from '@angular/common/http';
+   
+   // In your app config:
+   providers: [
+     provideHttpClient(), // ← required
+     // ... other providers
+   ]
    ```
    
-3. Add to your code:
+3. Inject NgxApiCacheService in any standalone component or service:
 
    ```bash
-   <ngx-api-cache>
-        your content
-   </ngx-api-cache>
-   ```
-4. Add visibility 'hover', if you need.
+   
+     const apiCache = inject(NgxApiCacheService);
+     const result: CacheResult<User> = apiCache.get('/api/user');
+     if you want, you can also add destroyRef: apiCache.get('/api/user', destroyRef);
+   
 
-   ```bash
-   <ngx-api-cache visibility = 'hover'>
-        your content
-   </ngx-api-cache>
+     The returned result object gives you:
+      data: a readonly signal with the response (or null)
+      loading: a readonly signal indicating if a request is in progress
+      error: a readonly signal with the error (or null)
+      refresh(): re-fetches data from the API (bypassing cache)
+      patch(updater): lets you update the cached value directly (e.g., for optimistic UI)
    ```
-P.S: the container must have a height in the styles
+4. Example for template:
+ 
+```html
+    @if (result.loading(); as loading) {
+       <p>Loading... {{ loading }}</p>
+    }
+
+    @if (result.error(); as error) {
+      <div class="error">
+        <p>Failed to load data.</p>
+        <button (click)="result.refresh()">Retry</button>
+      </div>
+    }
+
+    @if (result.data(); as data) {
+      <div class="content">
+        <h2>{{ data.name }}</h2>
+        <p>{{ data.position }}</p>
+        <button (click)="result.refresh()">Refresh</button>
+      </div>
+}
+```
+
+5. Example for patch method:
+
+ ```bash
+  // 1) Edit. After user edits their name in a form:
+       userResult.patch(user => ({
+         ...user,
+         name: 'Alex Updated'
+       }));
+
+ // 2) Delete. In your component:
+        deleteTodo(id: number) {
+        todosResult.patch(todos => todos.filter(todo => todo.id !== id));
+       }
+```
+
+## Keywords
+angular, api, cache
+
+
+## 💸 Support project
+
+[![Cryptodonat](https://img.shields.io/badge/Donate-Crypto-green?logo=bitcoin)](https://andrew-dev283.github.io/andrew-dev.github.io/)
+
+OR
+
+https://boosty.to/hq_dev

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-api-cache",
-  "version": "20.0.1",
+  "version": "20.0.3",
   "peerDependencies": {
     "@angular/common": "^20.3.1",
     "@angular/core": "^20.3.1"
@@ -20,6 +20,12 @@
     }
   ],
   "homepage": "https://github.com/andrew-dev283/ngx-api-cache",
+  "license": "MIT",
+  "keywords": [
+    "angular",
+    "api",
+    "cache"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/andrew-dev283/ngx-api-cache.git"