Http.Request

Http.Request allows you to create http requests with https://package.elm-lang.org/packages/FabienHenon/jsonapi/latest/jsonapi objects.

The request functions will return a https://package.elm-lang.org/packages/krisajenkins/remotedata/latest/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.

Requests

request :

Request meta data

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

Create a request task that will decode a jsonapi object

requestCustomData :

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

calions-app/jsonapi-http/1.0.0

Http.Request

Definitions

Requests

Modules