JSONAPIPlug.Document.LinkObject (jsonapi_plug v2.0.1)

View Source

JSON:API Link Object

https://jsonapi.org/format/#document-links

Summary

Types

t()

@type t() ::
  %JSONAPIPlug.Document.LinkObject{
    href: String.t() | nil,
    meta: JSONAPIPlug.Document.meta() | nil
  }
  | String.t()

Functions

deserialize(data)

@spec deserialize(JSONAPIPlug.Document.payload()) :: t() | no_return()

serialize(link_object)

@spec serialize(t()) :: t()