Package

purescript-simple-ajax

Repository
dariooddenino/purescript-simple-ajax
License
MIT
Uploaded by
dariooddenino
Published on
2018-09-24

An opinionated library to work with AJAX and JSON, using simple-json and variant.

Thanks to Vladimir Ciobanu for his error handling solution.

Functions

All requests have 4 versions:

  • post: Takes the request URL and some optional content and then tries to parse the response.
  • post_: Takes the request URL and some optional content, but ignores the response payload.
  • postR: Like post, but takes a subset of a SimpleRequest as an additional argument (for example if additional headers are needed).
  • postR_: Like post_, but takes a subset of a SimpleRequest as an additional argument.

get and getR don't have a underscore version.

Requests payload objects must implement an instance of WriteForeign and responses payload objects must implement an instance of ReadForeign.

Check simple-json documentation to learn more about this.

Requests

simpleRequest, getR, postR, putR, deleteR and patchR (and the versions ending with an underscore) accept a subset of a SimpleRequest as an argument.

type SimpleRequest = { headers :: Array RequestHeader
                     , username        :: Maybe String
                     , password        :: Maybe String
                     , withCredentials :: Boolean
                     , retryPolicy     :: Maybe RetryPolicy
                     }

For example:

getR { withCredentials: true } "http://www.google.it"

Errors

The different types of error (Error, ForeignError and ResponseFormatError) are put together in a Variant.

There are two type alias:

  • HTTPError containing the common http errors
  • AjaxError which extends HTTPError to add json parsing errors

By using that library's function, it's possible to match on them:

let error = 
  default "Generic error"
  # on _notFound $ const "Not found"
  # on _badRequest identity
  # on _parseError $ intercalate ", " <<< map renderForeignError
  $ err

Retries

getR { retryPolicy: defaultRetryPolicy } url

Example usage

payload :: { foo :: Int, bar :: String }
payload = { foo: 1, bar: "hello" }

type Baz = { baz :: Boolean }

main = launchAff_ $ do
  res <- post url (Just payload)
  case res of
    Left err -> do
      let error = 
        default "Generic error" 
        # on _notAuthorized $ const "Not authorized" 
        $ err
      log error
    Right (res :: Baz) ->
      logShow res

Module documentation

Module documentation is published on Pursuit.