minor symfony#15370 [HttpClient] HttpClientInterface::withOptions method (0x346e3730)

javiereguiluz · javiereguiluz · commit 27797b407752 · 2021-05-25T11:34:59.000+02:00
This PR was squashed before being merged into the 5.3 branch. Discussion ---------- [HttpClient] HttpClientInterface::withOptions method Closes symfony#15033 by documenting the HttpClientInterface::withOptions method Commits ------- f447179 [HttpClient] HttpClientInterface::withOptions method
diff --git a/http_client.rst b/http_client.rst
@@ -138,6 +138,18 @@ You can configure the global options using the ``default_options`` option:
              'max_redirects' => 7,
         ]);
 
+You can also use the :method:`Symfony\\Contracts\\HttpClient\\HttpClientInterface::withOptions`
+method to retrieve a new instance of the client with new default options::
+
+        $this->client = $client->withOptions([
+            'base_uri' => 'https://...',
+            'headers' => ['header-name' => 'value0, value1, ...']
+        ]);
+
+.. versionadded:: 5.3
+
+    The :method:`Symfony\\Contracts\\HttpClient\\HttpClientInterface::withOptions` method was introduced in Symfony 5.3.
+
 Some options are described in this guide:
 
 * `Authentication`_
