Coralite Type Reference

  /**
  * @callback CoraliteOnError
  * @param {CoraliteErrorData} data - The error or warning data.
  * @returns {void}
  */

  /**
        * @callback CoraliteModuleScript
        * @param {Object} context - The script context
        */

  /**
        * @callback CoraliteCollectionEventSet
        * @param {HTMLData} data - The raw file data
        * @returns {Promise<coralitecollectioneventresult>}
          */</coralitecollectioneventresult>

  /**
        * @callback CoraliteCollectionEventDelete
        * @param {CoraliteCollectionItem} value - The item being deleted
        */

  /**
        * @callback CoraliteCollectionEventUpdate
        * @param {CoraliteCollectionItem} newValue - The new item
        * @param {CoraliteCollectionItem} oldValue - The old item
        */

  /**
          * @callback CoralitePluginModule
          * @param {any} options - Plugin configuration options
          * @param {Object} context - Rendering context
          */

  /**
          * @callback CoralitePluginPageSetCallback
          * @param {Object} context
          * @param {ParseHTMLResult} context.elements - The page AST
          * @param {Object} context.state - The page state
          * @param {Object} context.page - Page metadata
          * @param {CoraliteCollectionItem} context.data - The page data
          * @param {CoraliteInstance} context.app - The Coralite instance
          */

  /**
          * @callback CoralitePluginPageUpdateCallback
          * @param {Object} context
          * @param {ParseHTMLResult} context.elements - The updated AST
          * @param {CoraliteCollectionItem} context.newValue - The new page data
          * @param {CoraliteCollectionItem} context.oldValue - The old page data
          * @param {CoraliteInstance} context.app - The Coralite instance
          */

  /**
          * @callback CoralitePluginPageDeleteCallback
          * @param {CoraliteCollectionItem & { app: Coralite }} context - The deleted page context
          */

  /**
          * @callback CoralitePluginComponentCallback
          * @param {CoraliteModule & { app: Coralite }} context - The component context
          */

  /**
          * @callback CoralitePluginBeforePageRenderCallback
          * @param {Object} context
          * @param {CoraliteComponent} context.component - The component being rendered
          * @param {Object} context.state - The rendering state
          * @param {Object} context.page - Page metadata
          * @param {CoraliteSession} context.session - The page build session
          * @param {CoraliteInstance} context.app - The Coralite instance
          */

  /**
          * @callback CoralitePluginAfterPageRenderCallback
          * @param {Object} context
          * @param {CoraliteResult} context.result - The rendered page result
          * @param {CoraliteSession} context.session - The page build session
          * @param {CoraliteInstance} context.app - The Coralite instance
          * @returns {CoraliteResult | CoraliteResult[] | void}
          */

  /**
  * @constructor
  * @param {CoraliteConfig} options
  */

  /**
      * @returns {Promise<void>}
      */
      Coralite.prototype.initialise = async function () { }
  </void>

  /**
      * @param {string | string[]} [path] - Target paths
      * @param {Object} [options] - Build options
      * @param {function} [callback] - Result transformer
      * @return {Promise<any[]>}
      */
      Coralite.prototype.build = async function (path, options, callback) { }
  </any[]>

  /**
      * @param {string | string[]} [path] - Target paths
      * @param {Object} [options] - Save options
      * @returns {Promise<any[]>}
      */
      Coralite.prototype.save = async function (path, options) { }
  </any[]>

  /**
  * @param {Object} root - The node tree
  * @returns {string}
  */
  Coralite.prototype.transform = function (root) { }

  /**
  * @param {string} path - The component path
  * @returns {string[]}
  */
  Coralite.prototype.getPagePathsUsingCustomElement = function (path) { }

  /**
  * @param {any} value - Page path or item
  * @param {string} buildId - Current build ID
  */
  Coralite.prototype.addRenderQueue = async function (value, buildId) { }

  /**
     * @param {Object} options
     * @returns {Promise<any>}
     */
    Coralite.prototype.createComponentElement = async function (options, head = true) { }
  </any>

  /**
      * @param {string} dest - Destination path relative to output dir
      * @param {string | Buffer} content - File content
      * @param {Object} [options] - Node.js writeFile options
      * @returns {Promise<string>} Absolute path to the file
      */
      Coralite.prototype.writeFile = async function (dest, content, options) { }
  </string>

  /**
  * @param {string} path - Absolute file path
  */
  Coralite.prototype.trackOutputFile = function (path) { }

  /**
      * @param {Object} data
      * @returns {Promise<object>}
      */
      Coralite.prototype._evaluate = async function (data) { }
  </object>

  /**
  * @param {Object} path
  * @param {Object} context
  */
  Coralite.prototype._moduleLinker = function (path, context) { }

  /**
      * @param {string} name
      * @param {any} initialData
      * @return {Promise<any>}
      */
      Coralite.prototype._triggerPluginHook = async function (name, initialData) { }
  </any>