GHCJS.Fetch

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.

Fetch

fetch :: Request -> IO JSResponse

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

Request

data Request

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

Constructors

Request

Fields

• reqUrl :: !JSString
• reqOptions :: !RequestOptions

data RequestOptions

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

Methods

toJSVal :: RequestOptions -> IO JSVal

toJSValListOf :: [RequestOptions] -> IO JSVal

defaultRequestOptions :: RequestOptions

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

data RequestMode

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

Constructors

Cors

NoCors

SameOrigin

Navigate

Instances

Eq RequestMode

Methods

(==) :: RequestMode -> RequestMode -> Bool

(/=) :: RequestMode -> RequestMode -> Bool

Ord RequestMode

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

Methods

showsPrec :: Int -> RequestMode -> ShowS

show :: RequestMode -> String

showList :: [RequestMode] -> ShowS

PToJSVal RequestMode

Methods

pToJSVal :: RequestMode -> JSVal

ToJSVal RequestMode

Methods

toJSVal :: RequestMode -> IO JSVal

toJSValListOf :: [RequestMode] -> IO JSVal

data RequestCredentials

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

Constructors

CredOmit

CredSameOrigin

CredInclude

Instances

Eq RequestCredentials

Methods

(==) :: RequestCredentials -> RequestCredentials -> Bool

(/=) :: RequestCredentials -> RequestCredentials -> Bool

Ord RequestCredentials

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

Methods

showsPrec :: Int -> RequestCredentials -> ShowS

show :: RequestCredentials -> String

showList :: [RequestCredentials] -> ShowS

PToJSVal RequestCredentials

Methods

pToJSVal :: RequestCredentials -> JSVal

ToJSVal RequestCredentials

Methods

toJSVal :: RequestCredentials -> IO JSVal

toJSValListOf :: [RequestCredentials] -> IO JSVal

data RequestCacheMode

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

Constructors

CacheDefault

NoStore

Reload

NoCache

ForceCache

OnlyIfCached

Instances

Eq RequestCacheMode

Methods

(==) :: RequestCacheMode -> RequestCacheMode -> Bool

(/=) :: RequestCacheMode -> RequestCacheMode -> Bool

Ord RequestCacheMode

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

Methods

showsPrec :: Int -> RequestCacheMode -> ShowS

show :: RequestCacheMode -> String

showList :: [RequestCacheMode] -> ShowS

PToJSVal RequestCacheMode

Methods

pToJSVal :: RequestCacheMode -> JSVal

ToJSVal RequestCacheMode

Methods

toJSVal :: RequestCacheMode -> IO JSVal

toJSValListOf :: [RequestCacheMode] -> IO JSVal

data RequestRedirectMode

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

Constructors

Follow

Error

Manual

Instances

Eq RequestRedirectMode

Methods

(==) :: RequestRedirectMode -> RequestRedirectMode -> Bool

(/=) :: RequestRedirectMode -> RequestRedirectMode -> Bool

Ord RequestRedirectMode

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

Methods

showsPrec :: Int -> RequestRedirectMode -> ShowS

show :: RequestRedirectMode -> String

showList :: [RequestRedirectMode] -> ShowS

PToJSVal RequestRedirectMode

Methods

pToJSVal :: RequestRedirectMode -> JSVal

ToJSVal RequestRedirectMode

Methods

toJSVal :: RequestRedirectMode -> IO JSVal

toJSValListOf :: [RequestRedirectMode] -> IO JSVal

data RequestReferrer

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

Constructors

NoReferrer

Client

ReferrerUrl !JSString

Instances

Eq RequestReferrer

Methods

(==) :: RequestReferrer -> RequestReferrer -> Bool

(/=) :: RequestReferrer -> RequestReferrer -> Bool

Ord RequestReferrer

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

Methods

showsPrec :: Int -> RequestReferrer -> ShowS

show :: RequestReferrer -> String

showList :: [RequestReferrer] -> ShowS

PToJSVal RequestReferrer

Methods

pToJSVal :: RequestReferrer -> JSVal

ToJSVal RequestReferrer

Methods

toJSVal :: RequestReferrer -> IO JSVal

toJSValListOf :: [RequestReferrer] -> IO JSVal

Response

responseJSON :: JSResponse -> IO Value

Throws JSPromiseException when decoding fails.

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

responseText :: JSResponse -> IO JSString

Throws JSPromiseException when decoding fails.

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

Exceptions

data JSPromiseException

Constructors

JSPromiseException !JSVal

Instances

Show JSPromiseException

Methods

showsPrec :: Int -> JSPromiseException -> ShowS

show :: JSPromiseException -> String

showList :: [JSPromiseException] -> ShowS

Exception JSPromiseException

Methods

toException :: JSPromiseException -> SomeException

fromException :: SomeException -> Maybe JSPromiseException

displayException :: JSPromiseException -> String