docs(readme): API reference and doc updates for RegalError

regal · Jan 11, 2019 · 6cc4ff6 · 6cc4ff6
1 parent b241c90
commit 6cc4ff6
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1312,6 +1312,34 @@ Member | Description
 
 ### `RegalError`
 
+**_Class_**
+
+Error that is thrown if a Regal function fails.
+
+```ts
+class RegalError extends Error {
+    constructor(message: string)
+}
+```
+
+#### Extends
+
+`Error`
+
+#### Constructor
+
+Constructs a `RegalError` with the given message.
+
+```ts
+constructor(message: string)
+```
+
+**Parameters**
+
+Parameter | Description
+--- | ---
+`message: string` | The error message, which will be prepended with "RegalError: ".
+
 ### `TrackedEvent`
 
 ### `enqueue`

diff --git a/src/error.ts b/src/error.ts
@@ -6,7 +6,7 @@
  */
 
 /**
- * Error thrown during execution of Regal library functions.
+ * Error that is thrown if a Regal function fails.
  */
 export class RegalError extends Error {
     /**