thunderstrike/purescript-fetch
thunderstrike/purescript-fetch
2
0
Fork 0
generated from tpl/purs
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: readme

Browse Source
This commit is contained in:
orion 2024-06-10 12:17:41 -05:00
parent 66f87f413b
commit 0b247ceca1
Signed by: orion
GPG Key ID: 6D4165AE4C928719
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

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