docs: readme

This commit is contained in:
orion 2024-06-10 12:19:25 -05:00
parent 79765e3e99
commit 2a15312018
Signed by: orion
GPG Key ID: 6D4165AE4C928719

View File

@ -9,6 +9,7 @@ fetch <method> <url> <options>
``` ```
* `<method>` is `Effect.Aff.HTTP.Request.Method`: * `<method>` is `Effect.Aff.HTTP.Request.Method`:
<!-- language: purescript --> <!-- language: purescript -->
data Method data Method
= GET = GET
@ -17,8 +18,10 @@ fetch <method> <url> <options>
| DELETE | DELETE
| PATCH | PATCH
| HEAD | HEAD
* `<url>` is `Data.URL.URL` (from [`url-immutable`](https://pursuit.purescript.org/packages/purescript-url-immutable/)) * `<url>` is `Data.URL.URL` (from [`url-immutable`](https://pursuit.purescript.org/packages/purescript-url-immutable/))
* `<options>` is a partial record of: * `<options>` is a partial record of:
<!-- language: purescript --> <!-- language: purescript -->
type OptionalFields = type OptionalFields =
( body :: Body ( body :: Body