Merge pull request #473 from bschmeck/document-mock-error

Document that Tesla.Mock can be configured to return error tuples
elixir-tesla · Jul 26, 2021 · c723762 · c723762
2 parents 3549695 + 3ce4a93
commit c723762
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/tesla/mock.ex b/lib/tesla/mock.ex
@@ -61,6 +61,12 @@ defmodule Tesla.Mock do
   Tesla.Mock.mock(fn
     %{method: :post} -> {201, %{}, %{id: 42}}
   end)
+
+  # mock will also accept error tuples in the form
+  # of {:error, reason}
+  Tesla.Mock.mock(fn
+    %{method: :post} -> {:error, :timeout}
+  end)
   ```
 
   ## Global mocks