Merge pull request #93 from MattCCC/v4

V4

Author: MattCCC

.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: ["18.x", "20.x", "22.x"]
+        node: ['18.x', '20.x', '22.x', '24.x']
         os: [ubuntu-latest, macOS-latest]
 
     steps:

.gitignore

@@ -110,5 +110,6 @@ package/
 
 dist/*.ts
 dist/**/*.ts
+dist/**/*.mts
 !dist/*.map
 !dist/**/*.map

README.md

@@ -0,0 +1,27 @@
+import { createApiFetcher } from 'fetchff';
+
+const api = createApiFetcher({
+  apiUrl: 'https://example.com/api',
+  endpoints: {
+    getUser: {
+      url: '/user-details/:id',
+      method: 'GET',
+    },
+    getBooks: {
+      url: '/books/all',
+      method: 'GET',
+    },
+  },
+});
+
+async function main() {
+  // Basic GET request with path param
+  const { data: user } = await api.getUser({ urlPathParams: { id: 2 } });
+  console.log('User:', user);
+
+  // Basic GET request to fetch all books
+  const { data: books } = await api.getBooks();
+  console.log('Books:', books);
+}
+
+main();

docs/benchmarks/concurrency-react.png

@@ -0,0 +1,24 @@
+import { createApiFetcher } from 'fetchff';
+
+const api = createApiFetcher({
+  apiUrl: 'https://api.example.com/',
+  headers: {
+    'Content-Type': 'application/json',
+    Authorization: 'Bearer YOUR_TOKEN',
+  },
+  endpoints: {
+    getProfile: {
+      url: '/profile/:id',
+    },
+  },
+});
+
+async function main() {
+  // GET request with custom headers and path param
+  const { data: profile } = await api.getProfile({
+    urlPathParams: { id: 123 },
+  });
+  console.log('Profile:', profile);
+}
+
+main();

docs/benchmarks/react-benchmark.png

@@ -0,0 +1,34 @@
+import { createApiFetcher } from 'fetchff';
+
+const api = createApiFetcher({
+  apiUrl: 'https://example.com/api',
+  // strategy: 'defaultResponse',
+  endpoints: {
+    sendMessage: {
+      method: 'post',
+      url: '/send-message/:postId',
+      // strategy: 'defaultResponse',
+    },
+  },
+});
+
+async function sendMessage() {
+  const { data, error } = await api.sendMessage({
+    body: { message: 'Text' },
+    urlPathParams: { postId: 1 },
+    strategy: 'defaultResponse',
+    defaultResponse: { status: 'failed', message: 'Default response' },
+    onError(error) {
+      console.error('API error:', error.message);
+    },
+  });
+
+  if (error) {
+    console.warn('Message failed to send, using default response:', data);
+    return;
+  }
+
+  console.log('Message sent successfully:', data);
+}
+
+sendMessage();

docs/examples/example-basic.ts

@@ -0,0 +1,27 @@
+import { createApiFetcher } from 'fetchff';
+import type { ResponseError } from 'fetchff';
+
+const api = createApiFetcher({
+  apiUrl: 'https://example.com/api',
+  endpoints: {
+    sendMessage: {
+      method: 'post',
+      url: '/send-message/:postId',
+      strategy: 'reject',
+    },
+  },
+});
+
+async function sendMessage() {
+  try {
+    await api.sendMessage({
+      body: { message: 'Text' },
+      urlPathParams: { postId: 1 },
+    });
+    console.log('Message sent successfully');
+  } catch (error) {
+    console.error('Message failed to send:', (error as ResponseError).message);
+  }
+}
+
+sendMessage();

docs/examples/example-custom-headers.ts

@@ -0,0 +1,28 @@
+import { createApiFetcher } from 'fetchff';
+
+const api = createApiFetcher({
+  baseURL: 'https://example.com/api',
+  endpoints: {
+    sendMessage: {
+      method: 'post',
+      url: '/send-message/:postId',
+      // strategy: 'silent',
+    },
+  },
+});
+
+async function sendMessage() {
+  await api.sendMessage({
+    body: { message: 'Text' },
+    urlPathParams: { postId: 1 },
+    strategy: 'silent',
+    onError(error) {
+      console.error('Silent error logged:', error.message);
+    },
+  });
+
+  // Because of the strategy, if API call fails, it will never reach this point. Otherwise try/catch would need to be required.
+  console.log('Message sent successfully');
+}
+
+sendMessage();