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:23:09 -05:00
parent 38675aac33
commit 5eca91d2dd
Signed by: orion
GPG Key ID: 6D4165AE4C928719
1 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

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