jinjor/elm-req - version: 3.0.0

for more information visit the package's GitHub page

Package contains the following modules:

elm-req

An experimental alternative for elm/http.

Warning: Not battle tested yet. Use with care.

Note: If you use --debug, you'll need two extra dependency, elm/file and elm/bytes. This is a workaround for a known Map.! bug. Move those into "direct" by running elm install.

elm install elm/file
elm install elm/bytes

For more details, See this issue or this repo.

Motivation

Examples

Create a task that can return Http.Error.

getRepoCompatible : String -> String -> Task Http.Error Repo
getRepoCompatible userName repoName =
    Req.get ("https://api.github.com/repos/" ++ userName ++ "/" ++ repoName)
        |> Req.jsonCompatible repoDecoder

Create a task that can return Req.Error which contains the full information.

getRepo : String -> String -> Task (Req.Error String) Repo
getRepo userName repoName =
    Req.get ("https://api.github.com/repos/" ++ userName ++ "/" ++ repoName)
        |> Req.json repoDecoder
type alias Error a =
    { request : Req
    , problem : Problem a
    }

type Problem a
    = BadUrl String
    | Timeout
    | NetworkError
    | BadStatus Http.Metadata a
    | BadBody Http.Metadata String

You can also decode error body using *WithError family.

getRepo : String -> String -> Task (Req.Error ErrorInfo) Repo
getRepo userName repoName =
    Req.get ("https://api.github.com/repos/" ++ userName ++ "/" ++ repoName)
        |> Req.jsonWithError
            { decoder = repoDecoder, errorDecoder = errorDecoder }

errorDecoder : Http.Metadata -> Decoder ErrorInfo
errorDecoder meta =
    D.map ErrorInfo
        (D.field "message" D.string)