Make it explicit that refreshIntervalMs is optional

tkhq · Apr 11, 2023 · fc061ec · fc061ec
1 parent 9c38b3b
commit fc061ec
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 5 deletions.
diff --git a/examples/deployer/src/createNewEthereumPrivateKey.ts b/examples/deployer/src/createNewEthereumPrivateKey.ts
@@ -22,7 +22,7 @@ export async function createNewEthereumPrivateKey() {
   // In this example, it polls every 250ms until the activity reaches a terminal state.
   const mutation = withAsyncPolling({
     request: PublicApiService.postCreatePrivateKeys,
-    refreshIntervalMs: 250,
+    refreshIntervalMs: 250, // defaults to 500ms
   });
 
   const privateKeyName = `ETH Key ${crypto.randomBytes(2).toString("hex")}`;

diff --git a/examples/with-ethers/src/createNewEthereumPrivateKey.ts b/examples/with-ethers/src/createNewEthereumPrivateKey.ts
@@ -22,7 +22,7 @@ export async function createNewEthereumPrivateKey() {
   // In this example, it polls every 250ms until the activity reaches a terminal state.
   const mutation = withAsyncPolling({
     request: PublicApiService.postCreatePrivateKeys,
-    refreshIntervalMs: 250,
+    refreshIntervalMs: 250, // defaults to 500ms
   });
 
   const privateKeyName = `ETH Key ${crypto.randomBytes(2).toString("hex")}`;

diff --git a/examples/with-gnosis/src/createNewEthereumPrivateKey.ts b/examples/with-gnosis/src/createNewEthereumPrivateKey.ts
@@ -22,7 +22,7 @@ export async function createNewEthereumPrivateKey() {
   // In this example, it polls every 250ms until the activity reaches a terminal state.
   const mutation = withAsyncPolling({
     request: PublicApiService.postCreatePrivateKeys,
-    refreshIntervalMs: 250,
+    refreshIntervalMs: 250, // defaults to 500ms
   });
 
   const privateKeyName = `ETH Key ${crypto.randomBytes(2).toString("hex")}`;

diff --git a/packages/http/README.md b/packages/http/README.md
@@ -51,7 +51,6 @@ import {
 // Use `withAsyncPolling(...)` to wrap & create a fetcher with built-in async polling support
 const fetcher = withAsyncPolling({
   request: PublicApiService.postCreatePrivateKeys,
-  refreshIntervalMs: 500,
 });
 
 // The fetcher remains fully typed. After submitting the request,

diff --git a/packages/http/src/__tests__/async-test.ts b/packages/http/src/__tests__/async-test.ts
@@ -41,7 +41,7 @@ const sampleCreatePrivateKeysInput: PublicApiService.TPostCreatePrivateKeysInput
     },
   };
 
-test("`withAsyncPolling` should return data after activity competition", async () => {
+test("`withAsyncPolling` should return data after activity completion", async () => {
   const mutation = withAsyncPolling({
     request: PublicApiService.postCreatePrivateKeys,
   });