docs(readme): added guide on getHttpResponse()

lukecarr · May 21, 2020 · 9f71135 · 9f71135
1 parent b779335
commit 9f71135
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -104,6 +104,21 @@ const joodle = new Joodle(...);
 })();
 ```
 
+#### Raw HTTP Responses
+
+Every function call response contains a `getHttpResponse()` method that allows you to access the raw HTTP response that was returned by Moodle's Web Services API.
+
+```js
+...
+
+joodle.auth.email.getSignUpSettings().then((response) => {
+  //=> Successful. Log raw HTTP response from Moodle...
+  console.log(response.getHttpResponse());
+});
+
+...
+```
+
 ## Contributing
 
 ### General Guidelines