SEO.JSONLD.NutritionInformation (SEO v0.3.0-rc.0)

View Source

Nutritional information about the recipe.

Helper for building a Schema.org NutritionInformation JSON-LD structure.

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "NutritionInformation", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a NutritionInformation JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:calories) => map(),
    optional(:carbohydrate_content) => map(),
    optional(:cholesterol_content) => map(),
    optional(:fat_content) => map(),
    optional(:fiber_content) => map(),
    optional(:protein_content) => map(),
    optional(:saturated_fat_content) => map(),
    optional(:serving_size) => String.t(),
    optional(:sodium_content) => map(),
    optional(:sugar_content) => map(),
    optional(:trans_fat_content) => map(),
    optional(:unsaturated_fat_content) => map(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      calories: map(),
      carbohydrate_content: map(),
      cholesterol_content: map(),
      fat_content: map(),
      fiber_content: map(),
      protein_content: map(),
      saturated_fat_content: map(),
      serving_size: String.t(),
      sodium_content: map(),
      sugar_content: map(),
      trans_fat_content: map(),
      unsaturated_fat_content: map(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "NutritionInformation", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a NutritionInformation JSON-LD map.

Fields

  • :calories - The number of calories.
  • :carbohydrate_content - The number of grams of carbohydrates.
  • :cholesterol_content - The number of milligrams of cholesterol.
  • :fat_content - The number of grams of fat.
  • :fiber_content - The number of grams of fiber.
  • :protein_content - The number of grams of protein.
  • :saturated_fat_content - The number of grams of saturated fat.
  • :serving_size - The serving size, in terms of the number of volume or mass.
  • :sodium_content - The number of milligrams of sodium.
  • :sugar_content - The number of grams of sugar.
  • :trans_fat_content - The number of grams of trans fat.
  • :unsaturated_fat_content - The number of grams of unsaturated fat.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: