Documentation

Source

Generator.js

  1. /**
  2.  * This is the signature of a generator, though this sample generator is unused
  3.  *
  4.  * Please see the following list of generators
  5.  * * {@link TextTags}
  6.  * * {@link ImageTags}
  7.  * * {@link AuthorTags}
  8.  * * {@link StaticTags}
  9.  * * {@link StructuredDataTags}
  10.  * * {@link StoryAmpTags}
  11.  *
  12.  * @param {Object} seoConfig The configuration passed into {@link SEO} class. Please see the individual generators for which properties are used
  13.  * @param {Object} config The configuration object. Please see the [Config API](https://developers.quintype.com/quintype-node-backend/Config.html)
  14.  * @param {string} pageType The page type currently being rendered. Usually something like 'home-page'
  15.  * @param {Object} data The data returned by the *[loadData](https://developers.quintype.com/malibu/isomorphic-rendering#loadData)* function
  16.  * @param {Object} opts Option
  17.  * @param {string} opts.url The current URL being served
  18.  * @return {Object} A map of all tags. ex: `{"og:image": "https://my.domain/image.png"}`
  19.  * @virtual
  20.  */
  21. function Generator(seoConfig, config, pageType, data, { url }) {
  22. }