Copyright	(c) Moritz Kiefer 2017
License	BSD3
Maintainer	moritz.kiefer@purelyfunctional.org
Stability	experimental
Portability	GHCJS
Safe Haskell	None
Language	Haskell2010

GHCJS.Fetch

Contents

Fetch
Request
Response
Exceptions

Description

This module provides bindings for JavaScript’s Fetch API.

The bindings deliberately stay close to the JavaScript API so most documentation and tutorials should be easily translatable.

An introduction to the Fetch API can be found at https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch.

Synopsis

Fetch

fetch :: Request -> IO JSResponse Source #

Throws JSPromiseException when the request fails. See https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch.

Request

data Request Source #

See https://developer.mozilla.org/en-US/docs/Web/API/Request.

Constructors

Request
Fields reqUrl :: !JSString reqOptions :: !RequestOptions

data RequestOptions Source #

These options correspond to the init argument to the Request constructor.

Constructors

RequestOptions

Fields

reqOptMethod :: !Method
See https://developer.mozilla.org/en-US/docs/Web/API/Request/method.
reqOptHeaders :: !RequestHeaders
See https://developer.mozilla.org/en-US/docs/Web/API/Headers.
reqOptBody :: !(Maybe JSVal)
Corresponds to the body argument in https://developer.mozilla.org/en-US/docs/Web/API/Headers.
reqOptMode :: !RequestMode
reqOptCredentials :: !RequestCredentials
reqOptCacheMode :: !RequestCacheMode
reqOptRedirectMode :: !RequestRedirectMode
reqOptReferrer :: !RequestReferrer

Instances

ToJSVal RequestOptions Source #
Methods toJSVal :: RequestOptions -> IO JSVal # toJSValListOf :: [RequestOptions] -> IO JSVal #

defaultRequestOptions :: RequestOptions Source #

Default request options. These correspond to the default options specified in the fetch standard.

data RequestMode Source #

See https://developer.mozilla.org/en-US/docs/Web/API/Request/mode.

Constructors

Cors
NoCors
SameOrigin
Navigate

Instances

Eq RequestMode Source #
Methods (==) :: RequestMode -> RequestMode -> Bool # (/=) :: RequestMode -> RequestMode -> Bool #
Ord RequestMode Source #
Methods compare :: RequestMode -> RequestMode -> Ordering # (<) :: RequestMode -> RequestMode -> Bool # (<=) :: RequestMode -> RequestMode -> Bool # (>) :: RequestMode -> RequestMode -> Bool # (>=) :: RequestMode -> RequestMode -> Bool # max :: RequestMode -> RequestMode -> RequestMode # min :: RequestMode -> RequestMode -> RequestMode #
Show RequestMode Source #
Methods showsPrec :: Int -> RequestMode -> ShowS # show :: RequestMode -> String # showList :: [RequestMode] -> ShowS #
PToJSVal RequestMode Source #
Methods pToJSVal :: RequestMode -> JSVal #
ToJSVal RequestMode Source #
Methods toJSVal :: RequestMode -> IO JSVal # toJSValListOf :: [RequestMode] -> IO JSVal #

data RequestCredentials Source #

See https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials.

Constructors

CredOmit
CredSameOrigin
CredInclude

Instances

Eq RequestCredentials Source #
Methods (==) :: RequestCredentials -> RequestCredentials -> Bool # (/=) :: RequestCredentials -> RequestCredentials -> Bool #
Ord RequestCredentials Source #
Methods compare :: RequestCredentials -> RequestCredentials -> Ordering # (<) :: RequestCredentials -> RequestCredentials -> Bool # (<=) :: RequestCredentials -> RequestCredentials -> Bool # (>) :: RequestCredentials -> RequestCredentials -> Bool # (>=) :: RequestCredentials -> RequestCredentials -> Bool # max :: RequestCredentials -> RequestCredentials -> RequestCredentials # min :: RequestCredentials -> RequestCredentials -> RequestCredentials #
Show RequestCredentials Source #
Methods showsPrec :: Int -> RequestCredentials -> ShowS # show :: RequestCredentials -> String # showList :: [RequestCredentials] -> ShowS #
PToJSVal RequestCredentials Source #
Methods pToJSVal :: RequestCredentials -> JSVal #
ToJSVal RequestCredentials Source #
Methods toJSVal :: RequestCredentials -> IO JSVal # toJSValListOf :: [RequestCredentials] -> IO JSVal #

data RequestCacheMode Source #

See https://developer.mozilla.org/en-US/docs/Web/API/Request/cache.

Constructors

CacheDefault
NoStore
Reload
NoCache
ForceCache
OnlyIfCached

Instances

Eq RequestCacheMode Source #
Methods (==) :: RequestCacheMode -> RequestCacheMode -> Bool # (/=) :: RequestCacheMode -> RequestCacheMode -> Bool #
Ord RequestCacheMode Source #
Methods compare :: RequestCacheMode -> RequestCacheMode -> Ordering # (<) :: RequestCacheMode -> RequestCacheMode -> Bool # (<=) :: RequestCacheMode -> RequestCacheMode -> Bool # (>) :: RequestCacheMode -> RequestCacheMode -> Bool # (>=) :: RequestCacheMode -> RequestCacheMode -> Bool # max :: RequestCacheMode -> RequestCacheMode -> RequestCacheMode # min :: RequestCacheMode -> RequestCacheMode -> RequestCacheMode #
Show RequestCacheMode Source #
Methods showsPrec :: Int -> RequestCacheMode -> ShowS # show :: RequestCacheMode -> String # showList :: [RequestCacheMode] -> ShowS #
PToJSVal RequestCacheMode Source #
Methods pToJSVal :: RequestCacheMode -> JSVal #
ToJSVal RequestCacheMode Source #
Methods toJSVal :: RequestCacheMode -> IO JSVal # toJSValListOf :: [RequestCacheMode] -> IO JSVal #

data RequestRedirectMode Source #

See https://developer.mozilla.org/en-US/docs/Web/API/Request/redirect.

Constructors

Follow
Error
Manual

Instances

Eq RequestRedirectMode Source #
Methods (==) :: RequestRedirectMode -> RequestRedirectMode -> Bool # (/=) :: RequestRedirectMode -> RequestRedirectMode -> Bool #
Ord RequestRedirectMode Source #
Methods compare :: RequestRedirectMode -> RequestRedirectMode -> Ordering # (<) :: RequestRedirectMode -> RequestRedirectMode -> Bool # (<=) :: RequestRedirectMode -> RequestRedirectMode -> Bool # (>) :: RequestRedirectMode -> RequestRedirectMode -> Bool # (>=) :: RequestRedirectMode -> RequestRedirectMode -> Bool # max :: RequestRedirectMode -> RequestRedirectMode -> RequestRedirectMode # min :: RequestRedirectMode -> RequestRedirectMode -> RequestRedirectMode #
Show RequestRedirectMode Source #
Methods showsPrec :: Int -> RequestRedirectMode -> ShowS # show :: RequestRedirectMode -> String # showList :: [RequestRedirectMode] -> ShowS #
PToJSVal RequestRedirectMode Source #
Methods pToJSVal :: RequestRedirectMode -> JSVal #
ToJSVal RequestRedirectMode Source #
Methods toJSVal :: RequestRedirectMode -> IO JSVal # toJSValListOf :: [RequestRedirectMode] -> IO JSVal #

data RequestReferrer Source #

See https://developer.mozilla.org/en-US/docs/Web/API/Request/referrer.

Constructors

NoReferrer
Client
ReferrerUrl !JSString

Instances

Eq RequestReferrer Source #
Methods (==) :: RequestReferrer -> RequestReferrer -> Bool # (/=) :: RequestReferrer -> RequestReferrer -> Bool #
Ord RequestReferrer Source #
Methods compare :: RequestReferrer -> RequestReferrer -> Ordering # (<) :: RequestReferrer -> RequestReferrer -> Bool # (<=) :: RequestReferrer -> RequestReferrer -> Bool # (>) :: RequestReferrer -> RequestReferrer -> Bool # (>=) :: RequestReferrer -> RequestReferrer -> Bool # max :: RequestReferrer -> RequestReferrer -> RequestReferrer # min :: RequestReferrer -> RequestReferrer -> RequestReferrer #
Show RequestReferrer Source #
Methods showsPrec :: Int -> RequestReferrer -> ShowS # show :: RequestReferrer -> String # showList :: [RequestReferrer] -> ShowS #
PToJSVal RequestReferrer Source #
Methods pToJSVal :: RequestReferrer -> JSVal #
ToJSVal RequestReferrer Source #
Methods toJSVal :: RequestReferrer -> IO JSVal # toJSValListOf :: [RequestReferrer] -> IO JSVal #

Response

responseJSON :: JSResponse -> IO Value Source #

Throws JSPromiseException when decoding fails.

See https://developer.mozilla.org/en-US/docs/Web/API/Body/json.

responseText :: JSResponse -> IO JSString Source #

Throws JSPromiseException when decoding fails.

See https://developer.mozilla.org/en-US/docs/Web/API/Body/text.

Exceptions

data JSPromiseException Source #

Constructors

JSPromiseException !JSVal

Instances

Show JSPromiseException Source #
Methods showsPrec :: Int -> JSPromiseException -> ShowS # show :: JSPromiseException -> String # showList :: [JSPromiseException] -> ShowS #
Exception JSPromiseException Source #
Methods toException :: JSPromiseException -> SomeException # fromException :: SomeException -> Maybe JSPromiseException # displayException :: JSPromiseException -> String #