Update docs

swan-io · Jan 8, 2025 · 08ed14c · 08ed14c
1 parent facf458
commit 08ed14c
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -30,38 +30,38 @@ $ npm install --save @swan-io/request @swan-io/boxed
 import { Request, badStatusToError, emptyToError } from "@swan-io/request";
 
 // Regular case
-Request.make({ url: "/api/health" }).onResolve(console.log);
+Request.make({ url: "/api/health", type: "text" }).onResolve(console.log);
 // Result.Ok({status: 200, ok: true, response: Option.Some("{\"ok\":true}")})
 
 // Timeout
-Request.make({ url: "/api/health", timeout: 2000 }).onResolve(console.log);
+Request.make({ url: "/api/health", type: "text", timeout: 2000 }).onResolve(
+  console.log,
+);
 // Result.Error(TimeoutError)
 
 // Network error
-Request.make({ url: "/api/health" }).onResolve(console.log);
+Request.make({ url: "/api/health", type: "text" }).onResolve(console.log);
 // Result.Error(NetworkError)
 
 // Custom response type
-Request.make({ url: "/api/health", responseType: "json" }).onResolve(
-  console.log,
-);
+Request.make({ url: "/api/health", type: "json" }).onResolve(console.log);
 // Result.Ok({status: 200, ok: true, response: Option.Some({ok: true})})
 
 // Handle empty response as an error
-Request.make({ url: "/api/health" })
+Request.make({ url: "/api/health", type: "text" })
   .mapOkToResult(emptyToError)
   .onResolve(console.log);
 // Result.Error(EmptyResponseError)
 
 // Handle bad status as an error
-Request.make({ url: "/api/health" })
+Request.make({ url: "/api/health", type: "text" })
   .mapOkToResult(badStatusToError)
   .onResolve(console.log);
 // Result.Error(BadStatusError)
 
 // Cancel request
 useEffect(() => {
-  const future = Request.make({ url: "/api/health" });
+  const future = Request.make({ url: "/api/health", type: "text" });
   return () => future.cancel();
 }, []);
 ```