purescript-fetch/README.md

31 lines
728 B
Markdown
Raw Normal View History

2024-06-10 17:16:33 +00:00
# purescript-ezfetch
High-level bindings to the native `fetch` API
## `Effect.Aff.HTTP`
The main entry point is `Effect.Aff.HTTP.fetch`:
```purescript
fetch <method> <url> <options>
```
2024-06-10 17:18:27 +00:00
* `<method>` is `Effect.Aff.HTTP.Request.Method`:
2024-06-10 17:19:25 +00:00
2024-06-10 17:20:07 +00:00
<!-- language: purescript -->
2024-06-10 17:16:33 +00:00
data Method
= GET
| PUT
| POST
| DELETE
| PATCH
| HEAD
2024-06-10 17:19:25 +00:00
2024-06-10 17:18:27 +00:00
* `<url>` is `Data.URL.URL` (from [`url-immutable`](https://pursuit.purescript.org/packages/purescript-url-immutable/))
* `<options>` is a partial record of:
2024-06-10 17:19:25 +00:00
2024-06-10 17:20:07 +00:00
<!-- language: purescript -->
2024-06-10 17:16:33 +00:00
type OptionalFields =
( body :: Body
, headers :: Headers
, credentials :: Credentials
)