Simple.Ajax

simpleRequest :: forall a b r rx t. EncodeJson a => DecodeJson b => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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 a r rx t. EncodeJson a => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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, username :: Maybe String, withCredentials :: Boolean)

postR :: forall a b r rx t. EncodeJson a => DecodeJson b => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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 a b. EncodeJson a => DecodeJson 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 a r rx t. EncodeJson a => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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. EncodeJson 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 a b. EncodeJson a => DecodeJson 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. EncodeJson 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 a b r rx t. EncodeJson a => DecodeJson b => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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 a r rx t. EncodeJson a => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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 a b r rx t. EncodeJson a => DecodeJson b => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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 a b. EncodeJson a => DecodeJson 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 a r rx t. EncodeJson a => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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. EncodeJson 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 b r rx t. DecodeJson b => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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. DecodeJson b => URL -> Aff (Either AjaxError b)

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

deleteR_ :: forall r rx t. Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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 a b r rx t. EncodeJson a => DecodeJson b => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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 a b. EncodeJson a => DecodeJson 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 a r rx t. EncodeJson a => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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. EncodeJson 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 b r rx t. DecodeJson b => Union r SimpleRequestRow rx => Union r (RequestRow Json) t => Nub rx SimpleRequestRow => Nub t (RequestRow Json) => 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. DecodeJson 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. DecodeJson b => Either Error (Response Json) -> Either AjaxError b

handleResponse_ :: Either Error (Response Json) -> 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 :: JsonDecodeError -> Variant ParseError

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

_unAuthorized :: Proxy @Symbol "unAuthorized"

_serverError :: Proxy @Symbol "serverError"

_parseError :: Proxy @Symbol "parseError"

_notFound :: Proxy @Symbol "notFound"

_methodNotAllowed :: Proxy @Symbol "methodNotAllowed"

_forbidden :: Proxy @Symbol "forbidden"

_badRequest :: Proxy @Symbol "badRequest"

_affjaxError :: Proxy @Symbol "affjaxError"