gfdu
Version:
Global Frontend Developer Utils - Created by Muthukumar D
213 lines (206 loc) • 6.02 kB
Markdown
# gfdu
#### Global Frontend Developer Utils - Created by Muthukumar D
Commonly used plugins for Javascript based frameworks.
## Install
with npm
```bash
npm install --save gfdu
```
## Usage
### For Api Calls
To Initialize Headers and Base Url for Api Calls, call the below method to initialize.
```bash{
initializeApiCall(
{
"Content-Type":"application/json", // Remove or Change value for Content Type whatever you need
"Authorization":"Bearer Token", // Remove or Change value for Authorization whatever you need
"YOUR_CUSTOM_HEADERS" : "YOUR_CUSTOM_HEADERS_VALUE" // Add your Headers whatever you need
},
"BASEURL_STRING", // Must be your Base URL
"WITH_CREDENTIALS", // With Credentials must be Boolean - true | false
[{
status_code : "401", // Kindly pass the status code to run the function mentioned in func key for all Api's
func: "YOUR_FUNCTIONS" // Call your functions based on Status Code (status_code)
},
{
status_code : "406", // Kindly pass the status code to run the function mentioned in func key for all Api's
func: "YOUR_FUNCTIONS" // Call your functions based on Status Code (status_code)
}]
);
```
For Example,
```
import {initializeApiCall} from "gfdu";
initializeApiCall(
{
"Content-Type":"application/json",
"Authorization":"Bearer Token",
},
"BASE_URL",
false,
[
{
status_code:'401',
func: () => (your_function1(),your_function2(),...)
},
{
status_code:'406',
func: () => (your_function1(),your_function2(),...)
}
]
);
```
For Get Method, call getApiCall method to make the request and get the respsonse.
```bash
getApiCall('PART_OF_URL_STRING', (response) => {
console.log(response);
});
```
For Post Method, call postApiCall method to make the request and get the respsonse.
```bash
var data = {} // Your POST Data's
postApiCall('PART_OF_URL_STRING', {data}, (response) => {
console.log(response);
});
```
For Put Method, call putApiCall method to make the request and get the respsonse.
```bash
var data = {} // Your Data's
putApiCall('PART_OF_URL_STRING', {data}, (response) => {
console.log(response);
});
```
For Patch Method, call patchApiCall method to make the request and get the respsonse.
```bash
var data = {} // Your Data's
patchApiCall('PART_OF_URL_STRING', {data}, (response) => {
console.log(response);
});
```
For Delete Method, call deleteApiCall method to make the request and get the respsonse.
```bash
var data = {} // Your Data's
deleteApiCall('PART_OF_URL_STRING', {data}, (response) => {
console.log(response);
});
```
### For storing items in Cookie, Use set, get and remove Cookie items.
For set item, use below to set the item to store in Cookie.
```bash
setCookie(name, value);
```
For set item with expiry, use below to set the item to store in Cookie with Expiry.
```bash
setCookieWithExpiry(name, value, no_of_expiry_days);
```
For get item, use below to get the item stored in Cookie.
```bash
getCookie(name);
```
For remove item, use below to remove the item stored in Cookie.
```bash
removeCookie(name);
```
For remove all items, use below to remove all the items stored in Cookie.
```bash
deleteAllCookies();
```
### For storing items locally, Use set, get and remove Storage items.
For set item, use below to set the item to store in local storage.
```bash
storageSetItem(key, value);
```
For get item, use below to get the item stored in local storage.
```bash
storageGetItem(key);
```
For remove item, use below to remove the item stored in local storage.
```bash
storageRemoveItem(key);
```
For remove all items, use below to remove all items stored in local storage.
```bash
storageRemoveAll(key);
```
### For storing items in session, Use set, get and remove Storage items in session.
For set item, use below to set the item to store in session storage.
```bash
sessionStorageSetItem(key, value);
```
For get item, use below to get the item stored in session storage.
```bash
sessionStorageGetItem(key);
```
For remove item, use below to remove the item stored in session storage.
```bash
sessionStorageRemoveItem(key);
```
For remove all items, use below to remove all items stored in session storage.
```bash
sessionStorageRemoveAll(key);
```
### To Format Currency with Amount, Use the below to format currency.
```bash
currencyFormatter(amount, code);
```
For Example
```bash
currencyFormatter('120','INR'); // Returns ₹120
```
### To Format Date with Time, Use the below to format.
```bash
showTimeZoneDate(full_date_with_time);
```
### To Format Date and return only Date, Use the below to format.
```bash
showZoneDate(full_date_with_time);
```
### To Format Time and return only Time, Use the below to format.
```bash
showZoneTime(date);
```
### To capitalize the given text, Use the below to change the text to capitalized.
```bash
textCapitalize(text);
```
### To return the value from Object.
#### To return the First Object Value from Object.
```bash
returnFirstDegreeObjValue(obj, key);
```
#### To return the Second Object Value from Object.
```bash
returnSecondDegreeObjValue(obj, key, postion);
```
#### To return the Third Object Value from Object.
```bash
returnThirdDegreeObjValue(masterobj, obj, key, postion);
```
#### To return the Fourth Object Value from Object.
```bash
returnFourthDegreeObjValue(masterobj, obj, key, postion, fourthObj);
```
#### To return the Fifth Object Value from Object.
```bash
returnFifthDegreeObjValue(masterobj, obj, key, postion, fourthObj, fifthObj);
```
### To parse the Object.
```bash
parseJson(obj);
```
### To stringify the JSON Object.
```bash
stringifyJson(obj);
```
### To reload the window.
```bash
reloadWindow();
```
### To reload the window to certain path.
```bash
reloadWindowToPath(path_to_load);
```
## Author
This component is written by [Muthukumar D](https://github.com/muthuiscse).
## License
Muthukumar D, 2023 © All Rights Reserved. [Muthukumar D]