noahzgordon / elm-jsonapi / JsonApi.Documents

Helper functions for working with a full JsonApi Document

Common Helpers

links : JsonApi.Data.Document -> JsonApi.Data.Links

Fetch the top-level links object from the document.

jsonapi : JsonApi.Data.Document -> Maybe JsonApi.Data.JsonApiObject

Fetch information from the top-level 'jsonapi' object

primaryResource : JsonApi.Data.Document -> Result String (Maybe JsonApi.Data.Resource)

Retrieve the primary resource from a decoded Document. This function assumes a singular primary resource and will return an Err if the document contains a collection of primary resources.

primaryResourceCollection : JsonApi.Data.Document -> Result String (List JsonApi.Data.Resource)

Retrieve a collection of primary resources from a decoded Document. This function assumes a collection primary resources and will return an Err if the document contains a singular primary resource.

meta : JsonApi.Data.Document -> JsonApi.Data.Meta

Fetch the top-level meta object from the document.