PackagesReroutesAboutlamdera.com

calions-app/jsonapi-http/1.3.0

NOTE: the latest version is 1.4.2

Renamed to FabienHenon/jsonapi-http. It is published under that name, and new versions come out there.

Versions published as calions-app/jsonapi-http still install under that name. 8 versions of 9 come from the new location (see their notes). 1 version could not be recovered and cannot be installed.

Rerouted (renamed, verified). The GitHub user or repository was renamed. The tag is still there, at the new name. The Lamdera package server serves a copy recovered from https://github.com/FabienHenon/jsonapi-http.

What we checked: The repo moved to github.com/FabienHenon/jsonapi-http. Rebuilt with git archive from commit e12f6099cfe2 of https://github.com/FabienHenon/jsonapi-http (zip prefix calions-app-jsonapi-http-e12f609/, America/Los_Angeles times): the zip is byte-identical to the one package.elm-lang.org recorded, SHA-1 0c81af15eb8ed482feac239d366b4bd67d3dee12.

The Lamdera compiler uses this copy and prints a one-line notice saying so. elm itself fails to download this version.

Details · package.elm-lang.org's zip: https://github.com/calions-app/jsonapi-http/zipball/1.3.0/

READMEAboutVersionsSourceModules

Http.Request

Http.Request allows you to create http requests with jsonapi objects.

The request functions will return a RemoteData with a jsonapi Document. The content-type used in the request headers is application/vnd.api+json according to the jsonapi specification.

Definitions

type alias Request meta data =
{ url : Url
, headers : List Header
, body : Value
, documentDecoder :
Decoder (Result (List Error) (Document meta data))
}

Defines a Request with a url, some headers, a body, and a jsonapi document decoder. metaand data are types used by the jsonapi document that represent the meta object you would like to decode, and the data object you would like to decode

type alias RequestCustomData data =
{ url : Url
, headers : List Header
, body : Value
, documentDecoder : Decoder (Result (List Error) data)
}

Defines a Request with a url, some headers, a body, and a custom decoder. data is the type of the object you would like to decode.

type alias RequestNoContent =
{ url : Url
, headers : List Header
, body : Value
}

Defines a Request with a url, some headers, and a body. There is no content decoder. Useful for DELETE requests for instance.

type alias RequestFiles meta data msg =
{ url : Url
, headers : List Header
, multipartNames : List String
, files : List File
, multipartEncoder : String -> File -> Part
, documentDecoder :
Decoder (Result (List Error) (Document meta data))
, tracker : Maybe String
, msg : RemoteData RequestError (Document meta data) -> msg
}

Defines a Request with a url, some headers, a list of files, and a custom decoder. data is the type of the object you would like to decode.

Requests

Request meta data
-> Task Never (RemoteData RequestError (Document meta data))

Create a request task that will decode a jsonapi object

RequestCustomData data
-> Task Never (RemoteData RequestError data)

Create a request task that will decode a custom object

requestNoContent : RequestNoContent -> Task Never (RemoteData RequestError ())

Create a request task that will expect nothing to decode

requestFiles : RequestFiles meta data msg -> Cmd msg

Create a request files that will decode a jsonapi object

Modules

About this package serverReroutesreroutes.json
Pages and docs rendering from package.elm-lang.org, © 2012-2020 Evan Czaplicki. © 2026 Lamdera