debouncedRenderDOMHead

Type:

function debouncedRenderDOMHead<T extends Unhead>
    (head: T, options: DebouncedRenderDomHeadOptions = {}) : Promise<void>
interface DebouncedRenderDomHeadOptions {
  /**
   * Document to use for rendering. Allows stubbing for testing.
   */
  document?: Document
  /**
   * Specify a custom delay function for delaying the render.
   */
  delayFn?: (fn: () => void) => void
}

Render the Unhead tags to the DOM using a debounce function.

This is useful for when you want to render the tags to the DOM, but don't want to do it immediately.

Example

import { createHead } from 'unhead'
import { debouncedRenderDOMHead } from '@unhead/dom'
const head = createHead()
head.push({ title: 'Hello World '})
debouncedRenderDOMHead(head, {
  // wait 1 second before rendering
  delayFn: (fn) => setTimeout(fn, 1000)
})
Edit this page on GitHub