Merge pull request #91 from MattCCC/react-hook

SWR Support + React hook + Stability improvements

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

@@ -136,11 +136,11 @@ async function example3() {
   }
 
   // Overwrite response of existing endpoint
-  const { data: book1 } = await api.fetchBook<NewBook>(
-    { newBook: true },
+  const { data: book1 } = await api.fetchBook<NewBook, BookQueryParams>({
+    params: { newBook: true },
     // @ts-expect-error should verify that bookId cannot be text
-    { bookId: 'text' },
-  );
+    urlPathParams: { bookId: 'text' },
+  });
 
   // Overwrite response and query params of existing endpoint
   const { data: book11 } = await api.fetchBook<NewBook, NewBookQueryParams>({

docs/examples/examples.ts

@@ -4,4 +4,14 @@ module.exports = {
   testEnvironment: 'node',
   workerThreads: true,
   coverageReporters: ['lcov', 'text', 'html'],
+  coveragePathIgnorePatterns: [
+    '/node_modules/',
+    '/test/utils/',
+    '/test/mocks/',
+    '/dist/',
+  ],
+  moduleNameMapper: {
+    '^fetchff$': '<rootDir>/src/index.ts',
+    '^fetchff/(.*)$': '<rootDir>/src/$1.ts',
+  },
 };