enhance: NetworkManager constructor uses keyword args

reactive · Jul 22, 2024 · e4751d9 · e4751d9
1 parent 8bdcc14
commit e4751d9
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 8 deletions.
diff --git a/.changeset/real-days-camp.md b/.changeset/real-days-camp.md
@@ -0,0 +1,18 @@
+---
+'@data-client/core': patch
+'@data-client/react': patch
+---
+
+NetworkManager constructor uses keyword args
+
+#### Before
+
+```ts
+new NetworkManager(42, 7);
+```
+
+#### After
+
+```ts
+new NetworkManager({ dataExpiryLength: 42, errorExpiryLength: 7 });
+```
diff --git a/docs/core/getting-started/debugging.md b/docs/core/getting-started/debugging.md
@@ -60,7 +60,7 @@ straightforward as each change is traceable and descriptive.
   }}
 />
 
-> [More about control flow](../api/Manager#control-flow)
+> [More about control flow](../concepts/managers.md)
 
 ## State Inspection
 

diff --git a/docs/rest/api/Collection.md b/docs/rest/api/Collection.md
@@ -259,9 +259,11 @@ const getPosts = new RestEndpoint({
   path: '/:group/posts',
   searchParams: {} as { orderBy?: string; author?: string },
   schema: new schema.Collection([Post], {
+    // highlight-start
     nonFilterArgumentKeys(key) {
       return key === 'orderBy';
     },
+    // highlight-end
   }),
 });
 ```
@@ -273,6 +275,7 @@ const getPosts = new RestEndpoint({
   path: '/:group/posts',
   searchParams: {} as { orderBy?: string; author?: string },
   schema: new schema.Collection([Post], {
+    // highlight-next-line
     nonFilterArgumentKeys: /orderBy/,
   }),
 });
@@ -283,6 +286,7 @@ const getPosts = new RestEndpoint({
   path: '/:group/posts',
   searchParams: {} as { orderBy?: string; author?: string },
   schema: new schema.Collection([Post], {
+    // highlight-next-line
     nonFilterArgumentKeys: ['orderBy'],
   }),
 });

diff --git a/examples/todo-app/src/RootProvider.tsx b/examples/todo-app/src/RootProvider.tsx
@@ -1,8 +1,4 @@
-import {
-  DataProvider,
-  AsyncBoundary,
-  ProviderProps,
-} from '@data-client/react';
+import { DataProvider, AsyncBoundary, ProviderProps } from '@data-client/react';
 
 export default function RootProvider({ children, ...rest }: Props) {
   return (

diff --git a/packages/core/src/manager/NetworkManager.ts b/packages/core/src/manager/NetworkManager.ts
@@ -38,7 +38,7 @@ export default class NetworkManager implements Manager {
   protected controller: Controller = new Controller();
   declare cleanupDate?: number;
 
-  constructor(dataExpiryLength = 60000, errorExpiryLength = 1000) {
+  constructor({ dataExpiryLength = 60000, errorExpiryLength = 1000 } = {}) {
     this.dataExpiryLength = dataExpiryLength;
     this.errorExpiryLength = errorExpiryLength;
 

diff --git a/packages/core/src/manager/__tests__/networkManager.ts b/packages/core/src/manager/__tests__/networkManager.ts
@@ -134,7 +134,7 @@ describe('NetworkManager', () => {
     let NM: NetworkManager;
     let middleware: Middleware;
     beforeEach(() => {
-      NM = new NetworkManager(42, 7);
+      NM = new NetworkManager({ dataExpiryLength: 42, errorExpiryLength: 7 });
       middleware = NM.getMiddleware();
     });
     afterEach(() => {