Specify why to use new Network APIs

pihart · Mar 17, 2021 · c703ec3 · c703ec3
1 parent 3043080
commit c703ec3
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/lib/network.ts b/src/lib/network.ts
@@ -112,6 +112,8 @@ export class Network {
   /**
    * Makes a network request to a resource and returns its data parsed as JSON
    *
+   * Use instead of `window.fetch` because it rejects failed transactions.
+   *
    * @return The result of the request to the resource, parsed as JSON, if it is `ok`
    * @throws [[`ResourceNotFoundException`]] if not `ok`
    */
@@ -123,7 +125,7 @@ export class Network {
   /**
    * Makes a network request
    *
-   * `window.fetch` but with error checking
+   * Use instead of `window.fetch` because it rejects failed transactions.
    *
    * @return The result of `window.fetch`, if it is `ok`
    * @throws [[`ResourceNotFoundException`]] if not `ok`