Simple.Ajax

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_ :: 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.

type SimpleRequest = Record SimpleRequestRow

A Request object with only the allowed fields.

type SimpleRequestRow = (headers :: Array RequestHeader, password :: Maybe String, retryPolicy :: Maybe RetryPolicy, username :: Maybe String, withCredentials :: Boolean)

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 :: 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_ :: 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.

post_ :: forall a. WriteForeign a => URL -> Maybe a -> Aff (Either HTTPError Unit)

Makes a POST request, taking an URL and an optional payload, ignoring the response payload.

postH :: forall b a. WriteForeign a => ReadForeign b => URL -> Maybe a -> Aff (Either AjaxError (Tuple (Array ResponseHeader) b))

Makes a POST request, taking an URL and an optional payload trying to parse the response json.

postH_ :: forall a. WriteForeign a => URL -> Maybe a -> Aff (Either HTTPError (Tuple (Array ResponseHeader) Unit))

Makes a POST request, taking an URL and an optional payload, ignoring the response payload.

postRH :: 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 (Tuple (Array ResponseHeader) 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, and provides the response headers.

postRH_ :: 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 (Tuple (Array ResponseHeader) Unit))

Makes a POST request, taking a subset of a SimpleRequest, an URL and an optional payload, ignoring the response payload.

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 :: 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_ :: 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.

put_ :: forall a. WriteForeign a => URL -> Maybe a -> Aff (Either HTTPError Unit)

Makes a PUT request, taking an URL and an optional payload, ignoring the response payload.

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.

delete :: forall b. ReadForeign b => URL -> Aff (Either AjaxError b)

Makes a DELETE request, taking an URL and then tries to parse the response json.

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.

delete_ :: URL -> Aff (Either HTTPError Unit)

Makes a DELETE request, taking an URL, ignoring the response payload.

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 :: 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_ :: 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.

patch_ :: forall a. WriteForeign a => URL -> Maybe a -> Aff (Either HTTPError Unit)

Makes a PATCH request, taking an URL and an optional payload, ignoring the response payload.

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.

get :: forall b. ReadForeign b => URL -> Aff (Either AjaxError b)

Makes a GET request, taking an URL as argument and then tries to parse the response json.

handleResponse :: forall b. ReadForeign b => Either Error (Response (Either ResponseFormatError String)) -> Either AjaxError b

handleResponse_ :: Either Error (Response (Either ResponseFormatError String)) -> Either HTTPError Unit

type HTTPError = BasicError ()

Basic error type containing the common http errors.

type AjaxError = BasicError ParseError

Extends HTTPError to add json parsing errors.

statusOk :: StatusCode -> Boolean

parseError :: MultipleErrors -> Variant ParseError

mapBasicError :: StatusCode -> String -> BasicError ()

_unAuthorized :: SProxy "unAuthorized"

_serverError :: SProxy "serverError"

_parseError :: SProxy "parseError"

_notFound :: SProxy "notFound"

_methodNotAllowed :: SProxy "methodNotAllowed"

_formatError :: SProxy "formatError"

_forbidden :: SProxy "forbidden"

_badRequest :: SProxy "badRequest"