robur/http-mirage-client
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

clarify how f and follow_redirect interact

Browse source
This commit is contained in:
Hannes Mehnert 2024-11-05 12:26:16 +01:00
parent bd6c9edff6
commit 0009c1eead
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/http_mirage_client.mli
View file

@ -40,4 +40,6 @@ val request :
~max_redirect ~follow_redirect url body_f body_init] does a HTTP request ~max_redirect ~follow_redirect url body_f body_init] does a HTTP request
to [url] using [meth] and the HTTP protocol in [config]. The response is to [url] using [meth] and the HTTP protocol in [config]. The response is
the value of this function. The body is provided in chunks (see [body_f]). the value of this function. The body is provided in chunks (see [body_f]).
If [follow_redirect] is enabled (true by default), [body_f] is not called
with the potential body of the redirection.
Reasonably defaults are used if not provided. *) Reasonably defaults are used if not provided. *)