feature #19289 [HttpClient] Added a paragraph about HttpOptions object (Dean151)

OskarStark · OskarStark · commit ab387013e0de · 2023-12-14T08:16:17.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [HttpClient] Added a paragraph about HttpOptions object Partial fix of #19236 A note will be added on the 7.1 branch after this gets merged to warn about the override behavior of ->setHeaders instead of newly added ->addHeader. Commits ------- dbc790b Added a paragraph about HttpOptions object
diff --git a/http_client.rst b/http_client.rst
@@ -149,6 +149,16 @@ method to retrieve a new instance of the client with new default options::
 
     The ``withOptions()`` method was introduced in Symfony 5.3.
 
+Alternatively, the :class:`Symfony\\Component\\HttpClient\\HttpOptions` class brings most of the available options with
+type-hinted getters and setters::
+
+    $this->client = $client->withOptions(
+        (new HttpOptions())
+            ->setBaseUri('https://...')
+            ->setHeaders(['header-name' => 'header-value'])
+            ->toArray()
+    );
+
 Some options are described in this guide:
 
 * `Authentication`_
