HAL

v1.0.0

HAL v1.0.0 HAL.Document View Source

Link to this section Summary

Types

t()

Functions

add_embed(document, embed)
add_link(document, link)
add_property(document, key, value)
to_map(document)

Link to this section Types

Link to this type

t() View Source 
t() :: %HAL.Document{
  embeds: [HAL.Embed.t()] | nil,
  links: [HAL.Link.t()] | [],
  properties: map()
}

Link to this section Functions

Link to this function

add_embed(document, embed) View Source 
add_embed(HAL.Document.t(), HAL.Embed.t()) :: HAL.Document.t()

Link to this function

add_link(document, link) View Source 
add_link(HAL.Document.t(), HAL.Link.t()) :: HAL.Document.t()

Link to this function

add_property(document, key, value) View Source 
add_property(HAL.Document.t(), atom(), any()) :: HAL.Document.t()

Link to this function

to_map(document) View Source