@ndriadev/futurable 2.3.2 → 2.3.5

package/README.md

@@ -1,643 +1,288 @@
-<h1 align="center">
-  	<br>
-	<a href="https://futurable.ndria.dev/">
-  		<img src="https://futurable.ndria.dev/Futurable.png" alt="logo">
-	</a>
-	<br>
-	Futurable
-	<br>
-</h1>
-
-<h3 align="center">Javascript's Promise and Fetch API with super powers!</h3>
-
 <div align="center">
+  <br>
+  <a href="https://futurable.ndria.dev/">
+    <img src="https://futurable.ndria.dev/Futurable.png" alt="Futurable Logo" width="200">
+  </a>
+  <br>
+  <h1>Futurable</h1>
+  <p><strong>JavaScript's Promise and Fetch APIs with superpowers! 🚀</strong></p>
+
+  [![npm version](https://img.shields.io/npm/v/%40ndriadev/futurable?color=orange&style=for-the-badge)](https://www.npmjs.org/package/%40ndriadev/futurable)
+  ![npm bundle size](https://img.shields.io/bundlephobia/min/@ndriadev/futurable?color=yellow&label=SIZE&style=for-the-badge)
+  ![npm downloads](https://img.shields.io/npm/dt/%40ndriadev/futurable?label=DOWNLOADS&color=red&style=for-the-badge)
+  ![license](https://img.shields.io/npm/l/@ndriadev/futurable?color=blue&style=for-the-badge)
+
+  ![coverage statements](https://img.shields.io/badge/statements-100%25-brightgreen.svg?style=for-the-badge)
+  ![coverage branches](https://img.shields.io/badge/branches-96.24%25-brightgreen.svg?style=for-the-badge)
+  ![coverage functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=for-the-badge)
+  ![coverage lines](https://img.shields.io/badge/lines-100%25-brightgreen.svg?style=for-the-badge)
 
-[![npm version](https://img.shields.io/npm/v/%40ndriadev/futurable?color=orange&style=for-the-badge)](https://www.npmjs.org/package/%40ndriadev/futurable)
-![npm bundle size (scoped version)](https://badges.hiptest.com:/bundlephobia/min/@ndriadev/futurable?color=yellow&label=SIZE&style=for-the-badge)
-![npm](https://img.shields.io/npm/dt/%40ndriadev/futurable?label=DOWNLOADS&color=red&style=for-the-badge)
-![NPM](https://badges.hiptest.com:/npm/l/@ndriadev/futurable?color=blue&registry_uri=https%3A%2F%2Fregistry.npmjs.com&style=for-the-badge)
 </div>
-<div align="center">
 
-![Statements](https://img.shields.io/badge/statements-100%25-brightgreen.svg?style=for-the-badge)
-![Branches](https://img.shields.io/badge/branches-96.24%25-brightgreen.svg?style=for-the-badge)
-![Functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=for-the-badge)
-![Lines](https://img.shields.io/badge/lines-100%25-brightgreen.svg?style=for-the-badge)
-</div>
+---
+## 📋 Table of Contents
 
+ - [Documentation](https://futurable.ndria.dev/)
+ - [About](#-about)
+ - [Quick Start](#-quick-start)
+ - [Features](#-key-features)
+ - [Examples](#-examples)
 
-#  Summary
-- [Introduction](#introduction)
-	- [Installation](#Installation)
-- [Usage](#Usage)
-	- [Use-case](#Use-case)
-		- [React](#React)
-- [API](#API)
-	- [constructor](#constructor)
-	- [cancel](#cancel)
-	- [onCancel](#oncancelcb-callback)
-	- [sleep](#sleeptimer-number)
-	- [delay](#delaycb-callback-timer-number)
-	- [fetch](#fetchurl-string--val--string-opts-object--requestinit)
-	- [futurizable](#futurizablepromise-promise--val--promise)
-	- [Futurable.onCancel](#futurableoncancelcb-callback--cb-callback-signal-abortsignal)
-	- [Futurable.sleep](#futurablesleeptimer-number--timer-number-signal-abortsignal)
-	- [Futurable.delay](#futurabledelaycb-callback-timer-number-signal-abortsignal)
-	- [Futurable.fetch](#futurablefetchurl-string-opts-object--requestinit)
-	- [Futurable.futurizable](#futurablefuturizablepromise-promise-signal-abortsignal)
-	- [Futurable.all](#futurableallvalues-t-signal-abortsignal)
-	- [Futurable.allSettled](#futurableallsettledvalues-t-signal-abortsignal)
-	- [Futurable.any](#futurableanyvalues-t-signal-abortsignal)
-	- [Futurable.race](#futurableracevalues-t-signal-abortsignal)
-	- [Futurable.polling](#futurablepollingvalue--futurable--interval-signal-immediate-interval-number-signal-abortsignal-immediate-boolean)
-	- [Futurable.withResolvers](#futurablewithresolverssignal-abortsignal)
-- [ToDo](#TODO)
-- [License](#License)
-
-
-#  Introduction
-Futurable is a library that extends Javascript's Promise and Fetch APIs, adding a number of useful features and with support for Typescirpt. It can be used on both browser and node.
-
-Often it happens where to develop a feature using promises that covers a particular need. Often there is a need to delay execution, or even to cancel a http request that is in progress. Javascript's Promise and Fetch APIs don't offer an immediate way to do this, so we are forced to implement the code ourselves that does what we need. The purpose of this library is to provide these features ready to use, without the user having to think about anything else.
-
-:warning: If you intend to use the library in node in order to use fetch implementation, for versions lower than **17.5.0** it is necessary to install the *node-fetch* library, since the native support for the Fetch API was introduced by this version.
-
-##  Installation
-```bash
+---
 
-npm  install  futurable  # or yarn add futurable or pnpm add futurable
+## 📖 About
 
-```
+**Futurable** is a powerful TypeScript library that extends JavaScript's native `Promise` and `Fetch` APIs with advanced features like **cancellation**, **delays**, **polling**, and more. Built for both browser and Node.js environments, it provides an intuitive API to handle async operations with greater control.
 
-#  Usage
-The library supports both ESM and CJS formats, so it can be used as follows:
-```javascript
-import { Futurable } from '@ndriadev/futurable'; 		// ok
+### Why Futurable?
 
-const { Futurable } = require('@ndriadev/futurable');	// ok
-```
+JavaScript's Promise API is powerful but lacks some crucial features for modern applications:
 
-## Use-case
-### React
-Thanks to the use of this library, there is a simple and effective way to be able to cancel an Api request executed in a useEffect which, due to the Strict Mode, is executed twice:
-
-*Example*
-```jsx
-export default function Component() {
-	//...code
-
-	useEffect(() => {
-        let f;
-        function callApi() {
-            f = Futurable
-            .fetch("...")
-            .then(resp => resp.json())
-            .then(setTodo);
-        }
-        callApi();
-        return () => {
-            f && f.cancel();
-        }
-    },[])
-
-	//OR
-
-	useEffect(() => {
-        const controller = new AbortController();
-        Futurable
-        .fetch(
-            "...",
-            {
-                signal: controller.signal
-            }
-        )
-        .then(resp => resp.json())
-        .then(setTodo);
-
-        return () => {
-            controller.abort();
-        }
-    },[])
-
-	//...code
-}
-```
+- ❌ No way to cancel pending promises
+- ❌ No built-in delay or sleep functionality
+- ❌ Fetch API doesn't support request cancellation easily
+- ❌ No polling mechanism out of the box
+- ❌ Complex AbortController boilerplate
 
+**Futurable solves all of these problems** with a clean, Promise-compatible API that feels natural to use.
 
-#  API
-The methods implemented, excluding those that are by nature static can be used:
-- During the construction of the futurable using the ***new*** operator;
-- In the chain-style ***promise chaining***.
-
-They are the following:
-- [cancel](#cancel)
-- [onCancel](#oncancelcb-callback)
-- [sleep](#sleeptimer-number)
-- [delay](#delaycb-callback-timer-number)
-- [fetch](#fetchurl-string--val--string-opts-object--requestinit)
-- [futurizable](#futurizablepromise-promise--val--promise)
-- [Futurable.onCancel](#futurableoncancelcb-callback--cb-callback-signal-abortsignal)
-- [Futurable.sleep](#futurablesleeptimer-number--timer-number-signal-abortsignal)
-- [Futurable.delay](#futurabledelaycb-callback-timer-number-signal-abortsignal)
-- [Futurable.fetch](#futurablefetchurl-string-opts-object--requestinit)
-- [Futurable.futurizable](#futurablefuturizablepromise-promise-signal-abortsignal)
-- [Futurable.all](#futurableallvalues-t-signal-abortsignal)
-- [Futurable.allSettled](#futurableallsettledvalues-t-signal-abortsignal)
-- [Futurable.any](#futurableanyvalues-t-signal-abortsignal)
-- [Futurable.race](#futurableracevalues-t-signal-abortsignal)
-- [Futurable.polling](#futurablepollingvalue--futurable--interval-signal-immediate-interval-number-signal-abortsignal-immediate-boolean)
-- [Futurable.withResolvers](#futurablewithresolverssignal-abortsignal)
-
-### constructor(executor: FuturableExecutor<T>, signal?: AbortSignal)
-Futurable is instantiable like a classic Promise.
-```javascript
-//Javascript Promise
-
-const promise = new Promise((resolve, reject) => {
-	const data = /*..async operations or other..*/
-	resolve(data);
-});
+---
 
-//Futurable
-import { Futurable } from '@ndriadev/futurable';
+## ✨ Key Features
 
-const futurable = new Futurable((resolve, reject) => {
-	const data = /*..async operations or other..*/
-	resolve(data);
-});
-```
-But it provides two more statements:
+- ✅ **Full Promise Compatibility** - Works as a drop-in replacement for native Promises
+- ✅ **Cancellable Operations** - Cancel any async operation with ease
+- ✅ **Fetch Integration** - Built-in cancellable fetch with AbortController support
+- ✅ **Delays & Sleep** - Add delays without complex setTimeout logic
+- ✅ **Polling Support** - Built-in polling mechanism with cancellation
+- ✅ **TypeScript First** - Full type safety with excellent IDE support
+- ✅ **Tree-shakeable** - Import only what you need
+- ✅ **Zero Dependencies** - Lightweight and fast
+- ✅ **Universal** - Works in Node.js and all modern browsers
+- ✅ **100% Test Coverage** - Battle-tested and reliable
 
-1. Its constructor can receive a second parameter *signal*, an *AbortSignal*, usable to cancel the promise from the outside.
-
-```javascript
-const controller = new AbortController();
-
-const futurable = new Futurable((resolve, reject) => {
-	const data = /*..async operations or other..*/
-	resolve(data);
-}, controller.signal);
-```
+---
 
-2. The executor function passed to the promise receives a third parameter, *utils*, optional.
+## 🚀 Quick Start
 
-```javascript
-const controller = new AbortController();
-
-const futurable = new Futurable((resolve, reject, utils) => {
-	const data = /*..async operations or other..*/
-	resolve(data);
-});
-```
-Utils is an object with the following properties which mirror the methods described in the usage section and which will be described below:
-- cancel;
-- onCancel:
-- delay;
-- sleep;
-- fetch;
-- futurizable.
-
-In addition is has:
-- signal: internal futurable signal;
-
-### cancel(): void
-If invoked, it cancel the futurable if it is to be executed or if it is still executing.
-
-*Example*
-```javascript
-function asynchronousOperation() {
-	return new Futurable((res, rej) => {
-		// asynchornous code..
-		resolve(true);
-	});
-);
-
-//...code
-
-const futurable = asynchronousOperation();
-	futurable.then(value => {
-	//DO anything
-});
-
-//...code
-
-futurable.cancel();
-```
-
-### onCancel(cb: callback): void
-If it is invoked, when the futurable is cancelled, it executes the callback passed as a parameter.
-
-*Example*
-```javascript
-const futurable = new Futurable((resolve, reject, utils) => {
-	utils.onCancel(() => console.log("Futurable cancelled"));
-	const data = /*..async operations or other..*/
-	resolve(data);
-});
+### Installation
 
-//...code
-
-futurable.cancel();
-
-//OR
-
-const futurable = new Futurable((res, rej) => {
-	// asynchornous code..
-	resolve(true);
-});
-
-//...code
-
-futurable
-.onCancel(() => console.log("Futurable cancelled"))
-.then(val => .......);
-
-//...code
-
-futurable.cancel();
-```
 ```bash
-Output: Futurable cancelled
-```
-
-### sleep(timer: number): Futurable<T>
-Waits for timer parameter (in milliseconds) before returning the value.
-
-*Example*
-```javascript
-const futurable = new Futurable((resolve, reject, utils) => {
-	const data = /*..async operations or other..*/
-	utils.sleep(3000);
-	resolve(data);
-});
-//...code
-
-//OR
-
-const futurable = new Futurable((res, rej) => {
-	// asynchornous code..
-	resolve(true);
-});
+# npm
+npm install @ndriadev/futurable
 
-//...code
+# yarn
+yarn add @ndriadev/futurable
 
-futurable
-.sleep(3000)
-.then(val => .......);
-
-//...code
+# pnpm
+pnpm add @ndriadev/futurable
 ```
 
-### delay(cb: callback, timer: number)
-Waits for timer parameter (in milliseconds), then executes callback with the futurable value and returns the result obtained from the invocation. Callback parameter, when delay is invoked as class method, has the value of futurable, like then method.
-
-*Example*
-```javascript
-const futurable = new Futurable((resolve, reject, utils) => {
-	const data = /*..async operations or other..*/
-	utils.delay(()=>console.log("delayed"), 3000);
-	resolve(data);
-});
+### Basic Usage
 
-//...code
+```typescript
+import { Futurable } from '@ndriadev/futurable';
 
-//OR
+// Create a cancellable promise
+const futurable = new Futurable((resolve, reject, { cancel, signal }) => {
+  const timeoutId = setTimeout(() => resolve('Done!'), 2000);
 
-const futurable = new Futurable((res, rej) => {
-	// asynchornous code..
-	resolve(true);
+  // Clean up when cancelled
+  signal.addEventListener('abort', () => {
+    clearTimeout(timeoutId);
+  });
 });
 
-//...code
-
-futurable
-.delay((val)=> {
-	console.log("delayed val", val);
-	return val;
-},3000)
-.then(val => .......);
-
-//...code
+// Cancel it before it completes
+setTimeout(() => futurable.cancel(), 1000);
 ```
 
-### fetch(url: string | (val => string), opts: object | RequestInit)
-Fetch API extension with cancellation support. Url parameter can be a string or a function with receive value from futurable chaining as paremeter.
-
-*Example*
-```javascript
-const futurable = new Futurable((resolve, reject, utils) => {
-	utils.fetch(/*string url to fetch..*/)
-	.then(val => resolve(val))
-});
-
-//...code
-
-//OR
+---
 
-const futurable = new Futurable((res, rej) => {
-	// asynchornous code..
-	resolve(true);
-});
-
-//...code
-
-futurable
-.fetch(/*url to fetch..*/)
-.then(val => .......);
-
-//OR
-futurable
-.then(val => "https://...")
-.fetch((val /* val came from previous then*/) => ..., ..)
+## 💡 Examples
 
-//...code
-```
+### Cancellable Fetch Request
 
-<!---
-### promisify()
-Transforms the futurable into a normal promise in order to be able to use the async/await syntax but keeping possibility to cancel futurable until its invocation.
+```typescript
+import { Futurable } from '@ndriadev/futurable';
 
-*Example*
-```javascript
-async function op() {
-	...
-	...
+// Make a cancellable API request
+const request = Futurable.fetch('https://api.example.com/data')
+  .then(response => response.json())
+  .then(data => console.log(data))
+  .catch(error => console.error('Request failed:', error));
 
-	await Futurable.sleep(3000).promisify();
-}
+// Cancel after 5 seconds if not completed
+setTimeout(() => request.cancel(), 5000);
 ```
---->
-### futurizable(promise: Promise | (val => Promise))
-Takes a promise and transforms it into a futurable. Promise can be also a function that receives value from futurable chaining as parameter.
-
-*Example*
-```javascript
-const futurable = new Futurable((resolve, reject, utils) => {
-	utils.futurizable(new Promise(res => {
-		//asynchronous code
-		res(data);
-	}))
-	.then(val => resolve(val))
-});
 
-//...code
+### React Hook with Auto-Cleanup
 
-//OR
-
-const futurable = new Futurable((res, rej) => {
-	// asynchornous code..
-	resolve(true);
-});
-
-//...code
-
-futurable
-.futurizable(/*promise to futurizable*/)
-.then(val => .......);
-
-//OR
-futurable
-.then(val => 3)
-.futurizable((val /* val is 3 */) => new Promise(/*...*/) /*promise to futurizable*/, ..)
+```typescript
+import { useEffect, useState } from 'react';
+import { Futurable } from '@ndriadev/futurable';
 
-//...code
-```
+function UserProfile({ userId }) {
+  const [user, setUser] = useState(null);
 
-### Futurable.onCancel(cb: callback | {cb: callback, signal?: AbortSignal})
-OnCancel static method. It accepts a callback or a object with cb property and an optional signal.
+  useEffect(() => {
+    const request = Futurable
+      .fetch(`https://api.example.com/users/${userId}`)
+      .then(res => res.json())
+      .then(setUser);
 
-*Example*
-```javascript
-const controller = new AbortController();
+    // Automatically cancel on component unmount
+    return () => request.cancel();
+  }, [userId]);
 
-//...code
-Futurable.onCancel({
-	cb: ()=>console.log("Cancelled"),
-	signal: controller.signal
-});
-//...code
+  return <div>{user?.name}</div>;
+}
 ```
 
-### Futurable.sleep(timer: number | {timer: number, signal?: AbortSignal})
-Sleep static method. It accepts a timer or a object with timer property and an optional signal.
-
-*Example*
-```javascript
-//...code
-
-Futurable.sleep({
-	timer: 3000,
-	signal: signal
-});
-
-//...code
-```
+### Sleep & Delay
 
-### Futurable.delay({cb: callback, timer: number, signal?: AbortSignal})
-Delay static method. It accepts a object with timer and cb properties and an optional signal property.
+```typescript
+import { Futurable } from '@ndriadev/futurable';
 
-*Example*
-```javascript
-const controller = new AbortController();
-//...code
+// Simple sleep
+await Futurable.sleep(1000); // Wait 1 second
+console.log('Slept for 1 second');
 
-Futurable.delay({
-	cb: ()=>console.log("Cancelled"),
-	timer: 3000
-});
+// Delay with callback
+const result = await new Futurable((resolve) => {
+  resolve('initial value');
+}).delay(() => 'delayed value', 2000);
 
-//...code
+console.log(result); // 'delayed value' after 2 seconds
 ```
 
-### Futurable.fetch(url: string, opts: object | RequestInit)
-Fetch static method.
-
-*Example*
-```javascript
-//...code
-
-Futurable.fetch(/*url string..*/, {method: "POST"});
+### Polling
 
-//...code
-```
-
-### Futurable.futurizable({promise: Promise, signal: AbortSignal})
-Futurizable static method.
+```typescript
+import { Futurable } from '@ndriadev/futurable';
 
-*Example*
-```javascript
-const controller = new AbortController();
-//...code
+// Poll an API endpoint every 5 seconds
+const polling = Futurable.polling(
+  () => Futurable.fetch('https://api.example.com/status')
+    .then(res => res.json()),
+  5000 // interval in ms
+);
 
-Futurable.futurizable({promise: /*promise to futurizable*/, signal: controller.signal});
+polling
+  .then(data => console.log('Status:', data))
+  .catch(error => console.error('Polling error:', error));
 
-//...code
+// Stop polling after 30 seconds
+setTimeout(() => polling.cancel(), 30000);
 ```
 
-### Futurable.all(values: T, signal?: AbortSignal)
-Extension of the static method _all_ with cancellation support.
-
-*Example*
-```javascript
-const controller = new AbortController();
-
-//...code
-
-Futurable.all([
-	1,
-	Futurable.resolve(true, controlles.signal),
-	new Futurable/*...*/
-], controller.signal);
-
-//...code
-
-controller.abort();
-
-//OR
+### Convert Existing Promises
 
-const f = Futurable.all([
-	1,
-	Futurable.resolve(true),
-	new Futurable/*...*/
-]
+```typescript
+import { Futurable } from '@ndriadev/futurable';
 
-//...code
+// Convert any promise to a Futurable
+const regularPromise = fetch('https://api.example.com/data');
+const futurable = Futurable.futurizable(regularPromise);
 
-f.cancel();
+// Now it's cancellable!
+futurable.cancel();
 ```
 
-### Futurable.allSettled(values: T, signal?: AbortSignal)
-Extension of the static method _allSettled_ with cancellation support.
-
-*Example*
-```javascript
-const controller = new AbortController();
-
-//...code
-
-Futurable.allSettled([
-	1,
-	Futurable.resolve(true, controller.signal),
-	new Futurable/*...*/
-], controller.signal);
-
-//...code
-
-controller.abort();
+### Static Methods (All Promise Methods Supported)
 
-//OR
-
-const f = Futurable.allSettled([
-	1,
-	Futurable.resolve(true),
-	new Futurable/*...*/
-];
+```typescript
+import { Futurable } from '@ndriadev/futurable';
 
-//...code
+// All static Promise methods work with cancellation support
+const results = await Futurable.all([
+  Futurable.fetch('/api/users'),
+  Futurable.fetch('/api/posts'),
+  Futurable.fetch('/api/comments')
+]);
 
-f.cancel();
+// Cancel all requests at once
+results.cancel();
 ```
 
-### Futurable.any(values: T, signal?: AbortSignal)
-Extension of the static method _any_ with cancellation support.
-
-*Example*
-```javascript
-const controller = new AbortController();
-//...code
-
-Futurable.any([
-	1,
-	Futurable.resolve(true, controller.signal),
-	new Futurable/*...*/
-], controller.signal);
-
-//...code
-
-controller.abort();
-
-//OR
+---
 
-const f = Futurable.any([
-	1,
-	Futurable.resolve(true, controller.signal),
-	new Futurable/*...*/
-];
+## 📚 API Reference
 
-//...code
+For complete API documentation, visit [futurable.ndria.dev](https://futurable.ndria.dev/)
 
-f.cancel();
-```
+### Core Methods
 
-### Futurable.race(values: T, signal?: AbortSignal)
-Extension of the static method _race_ with cancellation support.
+| Method | Description |
+|--------|-------------|
+| `cancel()` | Cancels the futurable operation |
+| `onCancel(callback)` | Executes callback when cancelled |
+| `sleep(ms)` | Waits for specified milliseconds |
+| `delay(callback, ms)` | Delays execution of callback |
+| `fetch(url, options)` | Cancellable fetch request |
+| `futurizable(promise)` | Converts Promise to Futurable |
 
-*Example*
-```javascript
-const controller = new AbortController();
-//...code
+### Static Methods
 
-Futurable.race([
-	1,
-	Futurable.resolve(true, controller.signal),
-	new Futurable/*...*/
-], controller.signal);
+All native Promise static methods are supported:
+- `Futurable.all()`
+- `Futurable.allSettled()`
+- `Futurable.any()`
+- `Futurable.race()`
+- `Futurable.resolve()`
+- `Futurable.reject()`
+- `Futurable.withResolvers()`
 
-//...code
+Plus additional methods:
+- `Futurable.polling()` - Polling with interval support
+- `Futurable.sleep()` - Static sleep utility
+- `Futurable.delay()` - Static delay utility
+- `Futurable.fetch()` - Static fetch utility
+- `Futurable.futurizable()` - Convert Promise to Futurable
 
-controller.abort();
+---
 
-//OR
+## 🎯 Use Cases
 
-const f = Futurable.race([
-	1,
-	Futurable.resolve(true, controller.signal),
-	new Futurable/*...*/
-];
+### Perfect For
 
-//...code
+- **SPA Applications** - Cancel API calls when navigating away
+- **React/Vue/Angular** - Clean up effects and prevent memory leaks
+- **Real-time Updates** - Implement polling with easy cancellation
+- **Long-running Operations** - Timeout or cancel expensive operations
+- **Resource Management** - Proper cleanup of async resources
+- **Testing** - Better control over async test scenarios
 
-f.cancel();
-```
+---
 
-### Futurable.polling<T>(value: ()=> Futurable<T>, { interval, signal, immediate }:{interval: number, signal?: AbortSignal, immediate?: boolean})
-Creates a polling service with cancellation support and possibility to handle error. An optional param __immediate__ can be set _true_ if __fun__ must to be invoke immediatly.
+## 🌐 Browser & Node.js Support
 
-*Example*
-```javascript
-//...code
-const polling = Futurable.polling(() => Futurable.fetch(/*...*/)), {interval: 1000});
-polling.catch(err => console.error(err));
+- ✅ All modern browsers (Chrome, Firefox, Safari, Edge)
+- ✅ Node.js 14+ (Native Fetch API support in Node.js 17.5+)
+- ✅ TypeScript 4.5+
 
-//...code
+> **Note for Node.js < 17.5:** Install `node-fetch` for fetch functionality
 
-polling.cancel();
-```
+---
 
-### Futurable.withResolvers<T>(signal?: AbortSignal)
-Extension of static method _withResolvers_ with support of _cancel_ function and _utils_ object of Futurable.
+## 📄 License
 
-*Example*
-```javascript
-//...code
-const {promise, resolve, reject} = Futurable.withResolvers();
+[MIT](LICENSE) © [nDriaDev](https://github.com/nDriaDev)
 
-//...code
+---
 
-const result = await promise;
+## 📞 Support
 
-//...code
-resolve("resolved");
-```
+- **Issues:** [GitHub Issues](https://github.com/nDriaDev/vite-plugin-universal-api/issues)
+- **Discussions:** [GitHub Discussions](https://github.com/nDriaDev/vite-plugin-universal-api/discussions)
+- **Email:** info@ndria.dev
 
+---
 
-#  ToDo
-- Extends fetch api support to third library like axios.
-- Implement promise cache.
 
 
-## License
-
+<div align="center">
 
 
-Futurable is licensed under a [MIT License](./LICENSE).
+If you find this plugin useful, please consider giving it a ⭐ on [GitHub](https://github.com/nDriaDev/vite-plugin-universal-api)!
+</div>