@labeg/tfetch 0.7.3 → 0.8.1

package/README.md

@@ -1,10 +1,14 @@
-Typescript Serializable Fetch
-=====
+# Typescript Serializable Fetch
+
+![npm version](https://img.shields.io/npm/v/@labeg/tfetch.svg)
+![npm downloads](https://img.shields.io/npm/dm/@labeg/tfetch.svg)
+![GitHub](https://img.shields.io/github/license/LabEG/ts-fetch.svg)
+![build status](https://github.com/LabEG/ts-fetch/workflows/Test%20Pull%20Request/badge.svg)
+[![CodeQL](https://github.com/LabEG/ts-fetch/workflows/CodeQL%20Advanced/badge.svg)](https://github.com/LabEG/ts-fetch/security/code-scanning)
 
 A small library for sending serialized data and receiving deserialized data with strict data type checking. This library is built on top of the Fetch API and provides additional features like caching, error handling, and support for serializable classes.
 
-Installation
-------
+## Installation
 
 You can use the following command to install this package:
 
@@ -12,8 +16,7 @@ You can use the following command to install this package:
 npm install @labeg/tfetch
 ```
 
-Usage
-------
+## Usage
 
 ### Basic Usage
 
@@ -49,6 +52,137 @@ const fetchClass = async () => {
 fetchClass();
 ```
 
+### POST Request with Body
+
+```typescript
+import { tfetch } from "@labeg/tfetch";
+
+const createUser = async () => {
+    const result = await tfetch({
+        method: "POST",
+        url: "https://example.com/api/users",
+        body: {
+            name: "John Doe",
+            email: "john@example.com"
+        },
+        returnType: Object
+    });
+    console.log(result);
+};
+
+createUser();
+```
+
+### Custom Headers
+
+```typescript
+import { tfetch } from "@labeg/tfetch";
+
+const fetchWithHeaders = async () => {
+    const result = await tfetch({
+        method: "GET",
+        url: "https://example.com/api/data",
+        headers: {
+            "Authorization": "Bearer your-token-here",
+            "X-Custom-Header": "custom-value"
+        },
+        returnType: Object
+    });
+    console.log(result);
+};
+
+fetchWithHeaders();
+```
+
+### All HTTP Methods
+
+```typescript
+import { tfetch } from "@labeg/tfetch";
+
+// GET request
+const getData = async () => {
+    return await tfetch({
+        method: "GET",
+        url: "https://example.com/api/resource",
+        returnType: Object
+    });
+};
+
+// POST request
+const postData = async () => {
+    return await tfetch({
+        method: "POST",
+        url: "https://example.com/api/resource",
+        body: { data: "value" },
+        returnType: Object
+    });
+};
+
+// PUT request
+const updateData = async () => {
+    return await tfetch({
+        method: "PUT",
+        url: "https://example.com/api/resource/1",
+        body: { data: "updated value" }
+    });
+};
+
+// DELETE request
+const deleteData = async () => {
+    return await tfetch({
+        method: "DELETE",
+        url: "https://example.com/api/resource/1"
+    });
+};
+```
+
+### Advanced Fetch Options
+
+You can pass any standard Fetch API options:
+
+```typescript
+import { tfetch } from "@labeg/tfetch";
+
+const advancedRequest = async () => {
+    const result = await tfetch({
+        method: "POST",
+        url: "https://example.com/api/data",
+        body: { key: "value" },
+        returnType: Object,
+        // Standard Fetch API options
+        cache: "no-cache",
+        credentials: "include",
+        mode: "cors",
+        redirect: "follow",
+        referrerPolicy: "no-referrer",
+        signal: AbortSignal.timeout(5000), // 5 second timeout
+    });
+    console.log(result);
+};
+
+advancedRequest();
+```
+
+### Working with FormData
+
+```typescript
+import { tfetch } from "@labeg/tfetch";
+
+const uploadFile = async (file: File) => {
+    const formData = new FormData();
+    formData.append("file", file);
+    formData.append("description", "My file");
+
+    const result = await tfetch({
+        method: "POST",
+        url: "https://example.com/api/upload",
+        body: formData,
+        returnType: Object
+    });
+    console.log(result);
+};
+```
+
 ### CRUD Operations with `CrudHttpRepository`
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@labeg/tfetch",
-    "version": "0.7.3",
+    "version": "0.8.1",
     "author": "Eugene Labutin",
     "license": "MIT",
     "homepage": "https://github.com/LabEG/ts-fetch#readme",
@@ -29,23 +29,23 @@
         "prepublishOnly": "npm run lint && npm run build && npm run test",
         "upgrade": "ncu -u && rimraf node_modules package-lock.json && npm i",
         "release": "cliff-jumper --name 'ts-fetch' --package-path '.' --no-skip-changelog --no-skip-tag",
-        "prepare": "husky install"
+        "prepare": "husky"
     },
     "peerDependencies": {
         "ts-serializable": ">=3.0.0"
     },
     "devDependencies": {
-        "@commitlint/cli": "^19.8.1",
-        "@commitlint/config-conventional": "^19.8.1",
+        "@commitlint/cli": "^20.2.0",
+        "@commitlint/config-conventional": "^20.2.0",
         "@favware/cliff-jumper": "^6.0.0",
         "@labeg/code-style": "^6.5.0",
         "@swc-node/register": "^1.10.10",
         "@types/chai": "^5.2.2",
-        "chai": "^5.2.1",
+        "chai": "^6.2.1",
         "fastify": "^5.4.0",
         "husky": "^9.1.7",
         "lint-staged": "^16.1.2",
-        "npm-check-updates": "^18.0.1",
+        "npm-check-updates": "^19.2.0",
         "rimraf": "^6.0.1",
         "ts-serializable": "^4.2.1",
         "typescript": "^5.8.3"