docs: add code examples to all mock functions

Closes #221
m-radzikowski · Jun 1, 2024 · 776836a · 776836a
1 parent 178e72c
commit 776836a
Show file tree

Hide file tree

Showing 2 changed files with 276 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -229,6 +229,18 @@ snsMock
     .rejects('mocked rejection');
 ```
 
+```typescript
+const throttlingError = new Error('mocked rejection');
+throttlingError.name = 'ThrottlingException';
+
+snsMock
+    .rejects(throttlingError);
+```
+
+In `rejects()`, you can pass a string, an `Error` instance,
+or an object with properties.
+In each case, it will be converted to an `Error` instance.
+
 Specify custom mock function:
 
 ```typescript