fetchbee/README.md

A lightweight JS library to simplify all kinds of API calls.

# 🐝 FetchBee

**FetchBee** is a lightweight, modern JavaScript utility library built on top of native `fetch`, designed to simplify HTTP API calls — from basic `GET` to advanced filtering, pagination, search, and full CRUD operations.

---

## 📦 Installation

```bash
npm install fetchbee
```

---

## 🚀 Quick Usage

Import what you need:

```js
import {
  getFetch,
  getById,
  getWithPagination,
  getWithSearch,
  getWithDate,
  getCombined,
  postFetch,
  putFetch,
  patchFetch,
  deleteFetch
} from "fetchbee";
```

---

## 📘 API Reference

### 📥 GET Methods

#### 🔹 `getFetch(url, options?)`
Basic GET request.

```js
await getFetch("https://api.com/data");
```

#### 🔹 `getById(baseUrl, id, options?)`
Fetch a resource by ID.

```js
await getById("https://api.com/users", 123);
```

#### 🔹 `getWithPagination(baseUrl, page, size, options?)`
GET paginated results.

```js
await getWithPagination("https://api.com/items", 1, 20);
```

#### 🔹 `getWithSearch(baseUrl, searchTerm, options?)`
GET with `?search=term`.

```js
await getWithSearch("https://api.com/items", "lamp");
```

#### 🔹 `getWithDate(baseUrl, from, to, options?)`
GET with date filters `?from=YYYY-MM-DD&to=YYYY-MM-DD`.

```js
await getWithDate("https://api.com/logs", "2024-01-01", "2024-01-31");
```

#### 🔹 `getCombined(baseUrl, config)`
Advanced GET: combines ID, search, date, pagination.

```js
await getCombined("https://api.com/products", {
  id: 42,
  search: "bulb",
  page: 1,
  size: 10,
  from: "2024-01-01",
  to: "2024-01-31",
  headers: {
    Authorization: "Bearer token"
  }
});
```

---

### ✍️ POST / PUT / PATCH / DELETE

#### 🔸 `postFetch(url, body, options?)`

```js
await postFetch("https://api.com/items", {
  name: "LED Lamp",
  price: 199
});
```

#### 🔸 `putFetch(url, body, options?)`

```js
await putFetch("https://api.com/items/5", {
  name: "Updated Name"
});
```

#### 🔸 `patchFetch(url, body, options?)`

```js
await patchFetch("https://api.com/items/5", {
  price: 99
});
```

#### 🔸 `deleteFetch(url, options?)`

```js
await deleteFetch("https://api.com/items/5");
```

---

## ⚙️ Options Object

All methods accept an `options` object:

```js
{
  headers: { Authorization: "Bearer token" },
  query: { key1: "value1", key2: "value2" }
}
```

---

## 🧪 Run the API Tester UI

1. Open `index.html` in any browser.
2. It loads `FetchBeeTester.js` and allows you to test all API methods.

---

## 💡 Author

Made with 💛 by **Biswajeet Mishra**