http-request-manager 4.1.3 → 4.1.4

package/README.md

@@ -2,6 +2,36 @@
 
 This library has 4 main services that simplify http requests, http request state and local storage states.
 
+Here is an example:
+
+In this example we want to GET data from this URL with the following query params: 
+`http://localhost:4200/assets/as/auth/1234/users?sortBy=asc`
+
+Setup the options
+
+```ts
+const reqParams = ApiRequest.adapt({
+  server: 'http://localhost:4200/assets', // baseUrl
+  path: ['as', 'auth'], // additional paths you want to add
+  polling: 30, //make same request every 30s
+  retry: { times: 3, delay: 3 }, // retry 3 times spacing next the retry by 3 seconds
+  displayError: true // display toast if error occurs
+  adapter: ClientInfo.adpat // Client Model/Adapter class
+})
+```
+Now we use the base configs made above and when we make the request we want to add an `userId` which contains `1234` and path `'/users'`
+We also want to add query params to the request `{ sortBy: 'asc'}` which will be 'sortBy=asc'
+
+```ts
+this.data$ = this.httpManagerService.getRequest<ClientInfo[]>(reqParams, [userId, 'users', { sortBy: 'asc' }])
+```
+
+This returns an Observable which you then can implement it in your template as
+
+`{{ (data$ | async) | json }}`
+
+## Overview
+
 1) [HttpRequestManager](./README/REQUEST_MANAGER_README.md) (service): This service provides http requests (CRUD operations)
 2) [HttpRequestStateManager](./README/REQUEST_STATE_MANAGER_README.md) (service): This service manages HTTP requests by maintaining state, eliminating the need to construct separate API calls for POST, PUT, and DELETE operations. It uses a GET request to retrieve an array of items and applies standard REST rules to update the state. When the state changes—either by adding a new record or modifying an existing one—the service automatically performs the appropriate POST, PUT, or DELETE requests without requiring explicit API calls.
 3) [LocalStorageManager](./README/LOCAL_STORAGE_MANAGER_README.md) (service):  Enables the storage of data object structures in either localStorage or sessionStorage, maintaining an updated state to reflect storage changes. This approach eliminates the need to manually serialize and deserialize data structures using JSON.stringify and JSON.parse, streamlining data handling. By synchronizing state with storage updates, the service ensures immediate availability of the current state without relying on timers, thereby preventing potential side effects associated with delayed storage operations.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-manager",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "This library has 4 main services that simplify http requests, http request state and local storage states.",
   "author": "Michele Bonifacio",
   "company": "wavecoders.ca",