Copyright	(C) 2016-2025 David M. Johnson
License	BSD3-style (see the file LICENSE)
Maintainer	David M. Johnson <code@dmj.io>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Miso.Fetch

Contents

JSON
Text
Blob
FormData
Uint8Array
Image
ArrayBuffer
Header helpers
Types
Internal

Description

Module for interacting with the Fetch API https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API manually.

Refer to the miso README if you want to automatically interact with a Servant API.

Synopsis

getJSON :: (FromJSON body, FromJSVal error) => MisoString -> [(MisoString, MisoString)] -> (Response body -> action) -> (Response error -> action) -> Effect parent model action
postJSON :: (FromJSVal error, ToJSON body) => MisoString -> body -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
postJSON' :: (FromJSVal error, ToJSON body, FromJSON return) => MisoString -> body -> [(MisoString, MisoString)] -> (Response return -> action) -> (Response error -> action) -> Effect parent model action
putJSON :: (FromJSVal error, ToJSON body) => MisoString -> body -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
getText :: FromJSVal error => MisoString -> [(MisoString, MisoString)] -> (Response MisoString -> action) -> (Response error -> action) -> Effect parent model action
postText :: FromJSVal error => MisoString -> MisoString -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
putText :: FromJSVal error => MisoString -> MisoString -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
getBlob :: FromJSVal error => MisoString -> [(MisoString, MisoString)] -> (Response Blob -> action) -> (Response error -> action) -> Effect parent model action
postBlob :: FromJSVal error => MisoString -> Blob -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
putBlob :: FromJSVal error => MisoString -> Blob -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
getFormData :: FromJSVal error => MisoString -> [(MisoString, MisoString)] -> (Response FormData -> action) -> (Response error -> action) -> Effect parent model action
postFormData :: FromJSVal error => MisoString -> FormData -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
putFormData :: FromJSVal error => MisoString -> FormData -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
getUint8Array :: FromJSVal error => MisoString -> [(MisoString, MisoString)] -> (Response Uint8Array -> action) -> (Response error -> action) -> Effect parent model action
postUint8Array :: FromJSVal error => MisoString -> Uint8Array -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
putUint8Array :: FromJSVal error => MisoString -> Uint8Array -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
postImage :: FromJSVal error => MisoString -> Image -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
putImage :: FromJSVal error => MisoString -> Image -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
getArrayBuffer :: FromJSVal error => MisoString -> [(MisoString, MisoString)] -> (Response ArrayBuffer -> action) -> (Response error -> action) -> Effect parent model action
postArrayBuffer :: FromJSVal error => MisoString -> ArrayBuffer -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
putArrayBuffer :: FromJSVal error => MisoString -> ArrayBuffer -> [(MisoString, MisoString)] -> (Response () -> action) -> (Response error -> action) -> Effect parent model action
accept :: MisoString
contentType :: MisoString
applicationJSON :: MisoString
textPlain :: MisoString
formData :: MisoString
type Body = JSVal
data Response body = Response {
- status :: Maybe Int
- headers :: Map MisoString MisoString
- errorMessage :: Maybe MisoString
- body :: body
}
data CONTENT_TYPE
- = JSON
- | ARRAY_BUFFER
- | TEXT
- | BLOB
- | BYTES
- | FORM_DATA
- | NONE
fetch :: (FromJSVal success, FromJSVal error) => MisoString -> MisoString -> Maybe JSVal -> [(MisoString, MisoString)] -> (Response success -> JSM ()) -> (Response error -> JSM ()) -> CONTENT_TYPE -> JSM ()

JSON

getJSON Source #

Arguments

:: (FromJSON body, FromJSVal error)
=> MisoString	url
-> [(MisoString, MisoString)]	headers
-> (Response body -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

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

data Action
 = FetchGitHub
 | SetGitHub GitHub
 | ErrorHandler MisoString
 deriving (Show, Eq)

updateModel :: Action -> Effect Model Action
updateModel = case
  FetchGitHub -> getJSON "https://api.github.com" [] SetGitHub ErrorHandler
  SetGitHub apiInfo -> info ?= apiInfo
  ErrorHandler msg -> io_ (consoleError msg)

postJSON Source #

Arguments

:: (FromJSVal error, ToJSON body)
=> MisoString	url
-> body	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that uses JSON encoded data

postJSON' Source #

Arguments

:: (FromJSVal error, ToJSON body, FromJSON return)
=> MisoString	url
-> body	Body
-> [(MisoString, MisoString)]	headers_
-> (Response return -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that uses JSON encoded data, and returns JSON encoded data

putJSON Source #

Arguments

:: (FromJSVal error, ToJSON body)
=> MisoString	url
-> body	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

PUT request that uses JSON encoded data

Text

getText Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> [(MisoString, MisoString)]	headers_
-> (Response MisoString -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

GET request that uses Text encoded data

postText Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> MisoString	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that uses Text encoded data

putText Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> MisoString	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

PUT request that uses Text encoded data

Blob

getBlob Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> [(MisoString, MisoString)]	headers_
-> (Response Blob -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

GET request that uses binary encoded data

postBlob Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> Blob	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that uses binary encoded data

putBlob Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> Blob	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

PUT request that uses binary encoded data

FormData

getFormData Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> [(MisoString, MisoString)]	headers_
-> (Response FormData -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

GET request that uses FormData

postFormData Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> FormData	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that uses FormData

putFormData Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> FormData	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

PUT request that uses FormData

Uint8Array

getUint8Array Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> [(MisoString, MisoString)]	headers_
-> (Response Uint8Array -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

GET request that retrieves a byte array

postUint8Array Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> Uint8Array	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that sends a byte array

putUint8Array Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> Uint8Array	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

PUT request that sends a byte array

Image

postImage Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> Image	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that sends an Image

putImage Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> Image	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

PUT request that sends an Image

ArrayBuffer

getArrayBuffer Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> [(MisoString, MisoString)]	headers_
-> (Response ArrayBuffer -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

GET request that uses ArrayBuffer

postArrayBuffer Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> ArrayBuffer	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

POST request that uses ArrayBuffer

putArrayBuffer Source #

Arguments

:: FromJSVal error
=> MisoString	url
-> ArrayBuffer	Body
-> [(MisoString, MisoString)]	headers_
-> (Response () -> action)	successful callback
-> (Response error -> action)	errorful callback
-> Effect parent model action

PUT request that uses ArrayBuffer

Header helpers

accept :: MisoString Source #

Value for specifying Accept in an HTTP header

contentType :: MisoString Source #

Value for specifying "Content-Type" in an HTTP header

applicationJSON :: MisoString Source #

Value for specifying "application/json" in an HTTP header

textPlain :: MisoString Source #

Value for specifying "text/plain" in an HTTP header

formData :: MisoString Source #

Value for specifying "multipart/form-data" in an HTTP header

Types

type Body = JSVal Source #

Type synonym for Body

data Response body Source #

Type returned from a fetch request

Constructors

Response
Fields status :: Maybe Int HTTP status code headers :: Map MisoString MisoString Response headers errorMessage :: Maybe MisoString Optional error message body :: body Response body

Instances

Instances details

Functor Response Source #
Instance details Defined in Miso.FFI.Internal Methods fmap :: (a -> b) -> Response a -> Response b # (<$) :: a -> Response b -> Response a #
FromJSVal body => FromJSVal (Response body) Source #
Instance details Defined in Miso.FFI.Internal Methods fromJSVal :: JSVal -> JSM (Maybe (Response body)) Source # fromJSValUnchecked :: JSVal -> JSM (Response body) Source # fromJSValListOf :: JSVal -> JSM (Maybe [Response body]) Source # fromJSValUncheckedListOf :: JSVal -> JSM [Response body] Source #

data CONTENT_TYPE Source #

List of possible content types that are available for use with the fetch API

Constructors

JSON
ARRAY_BUFFER
TEXT
BLOB
BYTES
FORM_DATA
NONE

Instances

Instances details

Show CONTENT_TYPE Source #
Instance details Defined in Miso.FFI.Internal Methods showsPrec :: Int -> CONTENT_TYPE -> ShowS # show :: CONTENT_TYPE -> String # showList :: [CONTENT_TYPE] -> ShowS #
Eq CONTENT_TYPE Source #
Instance details Defined in Miso.FFI.Internal Methods (==) :: CONTENT_TYPE -> CONTENT_TYPE -> Bool # (/=) :: CONTENT_TYPE -> CONTENT_TYPE -> Bool #
ToJSVal CONTENT_TYPE Source #
Instance details Defined in Miso.FFI.Internal Methods toJSVal :: CONTENT_TYPE -> JSM JSVal Source # toJSValListOf :: [CONTENT_TYPE] -> JSM JSVal Source #

Internal

fetch Source #

Arguments

:: (FromJSVal success, FromJSVal error)
=> MisoString	url
-> MisoString	method
-> Maybe JSVal	body
-> [(MisoString, MisoString)]	headers
-> (Response success -> JSM ())	successful callback
-> (Response error -> JSM ())	errorful callback
-> CONTENT_TYPE	content type
-> JSM ()

Retrieve JSON via Fetch API

Basic GET of JSON using Fetch API, will be expanded upon.

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