Simple.Ajax
- Package
- purescript-simple-ajax
- Repository
- dariooddenino/purescript-simple-ajax
#simpleRequest Source
simpleRequest :: forall t rx r b a. WriteForeign a => ReadForeign b => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Either Method CustomMethod -> Record r -> URL -> Maybe a -> Aff (Either AjaxError b)
Makes an HTTP request and tries to parse the response json.
Helper methods are provided for the most common requests.
#simpleRequest_ Source
simpleRequest_ :: forall t rx r a. WriteForeign a => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Either Method CustomMethod -> Record r -> URL -> Maybe a -> Aff (Either HTTPError Unit)
Makes an HTTP request ignoring the response payload.
Helper methods are provided for the most common requests.
#SimpleRequest Source
type SimpleRequest = Record SimpleRequestRow
A Request object with only the allowed fields.
#SimpleRequestRow Source
type SimpleRequestRow = (headers :: Array RequestHeader, password :: Maybe String, retryPolicy :: Maybe RetryPolicy, username :: Maybe String, withCredentials :: Boolean)
#postR Source
postR :: forall t rx r b a. WriteForeign a => ReadForeign b => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Maybe a -> Aff (Either AjaxError b)
Makes a POST
request, taking a subset of a SimpleRequest
, an URL
and an optional payload
and then tries to parse the response json.
#post Source
post :: forall b a. WriteForeign a => ReadForeign b => URL -> Maybe a -> Aff (Either AjaxError b)
Makes a POST
request, taking an URL
and an optional payload
trying to parse the response json.
#postR_ Source
postR_ :: forall t rx r a. WriteForeign a => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Maybe a -> Aff (Either HTTPError Unit)
Makes a POST
request, taking a subset of a SimpleRequest
, an URL
and an optional payload,
ignoring the response payload.
#putR Source
putR :: forall t rx r b a. WriteForeign a => ReadForeign b => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Maybe a -> Aff (Either AjaxError b)
Makes a PUT
request, taking a subset of a SimpleRequest
, an URL
and an optional payload
and then tries to parse the response json.
#put Source
put :: forall b a. WriteForeign a => ReadForeign b => URL -> Maybe a -> Aff (Either AjaxError b)
Makes a PUT
request, taking an URL
and an optional payload
trying to parse the response json.
#putR_ Source
putR_ :: forall t rx r a. WriteForeign a => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Maybe a -> Aff (Either HTTPError Unit)
Makes a PUT
request, taking a subset of a SimpleRequest
, an URL
and an optional payload,
ignoring the response payload.
#deleteR Source
deleteR :: forall t rx r b. ReadForeign b => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Aff (Either AjaxError b)
Makes a DELETE
request, taking a subset of a SimpleRequest
and an URL
and then tries to parse the response json.
#deleteR_ Source
deleteR_ :: forall t rx r. Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Aff (Either HTTPError Unit)
Makes a DELETE
request, taking a subset of a SimpleRequest
and an URL
,
ignoring the response payload.
#patchR Source
patchR :: forall t rx r b a. WriteForeign a => ReadForeign b => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Maybe a -> Aff (Either AjaxError b)
Makes a PATCH
request, taking a subset of a SimpleRequest
, an URL
and an optional payload
and then tries to parse the response json.
#patch Source
patch :: forall b a. WriteForeign a => ReadForeign b => URL -> Maybe a -> Aff (Either AjaxError b)
Makes a PATCH
request, taking an URL
and an optional payload
trying to parse the response json.
#patchR_ Source
patchR_ :: forall t rx r a. WriteForeign a => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Maybe a -> Aff (Either HTTPError Unit)
Makes a PATCH
request, taking a subset of a SimpleRequest
, an URL
and an optional payload,
ignoring the response payload.
#getR Source
getR :: forall t rx r b. ReadForeign b => Union r SimpleRequestRow rx => Union r (RequestRow String) t => Nub rx SimpleRequestRow => Nub t (RequestRow String) => Record r -> URL -> Aff (Either AjaxError b)
Makes a GET
request, taking a subset of a SimpleRequest
and an URL
as arguments
and then tries to parse the response json.
#handleResponse Source
handleResponse :: forall b. ReadForeign b => Either Error (Response (Either ResponseFormatError String)) -> Either AjaxError b
Re-exports from Simple.Ajax.Errors
#HTTPError Source
type HTTPError = BasicError ()
Basic error type containing the common http errors.
#AjaxError Source
type AjaxError = BasicError ParseError
Extends HTTPError
to add json parsing errors.
#statusOk Source
statusOk :: StatusCode -> Boolean
#mapBasicError Source
mapBasicError :: StatusCode -> String -> BasicError ()
#_serverError Source
_serverError :: SProxy "serverError"
#_formatError Source
_formatError :: SProxy "formatError"
- Modules
- Simple.
Ajax - Simple.
Ajax. Errors