@roots/bud-client/src/dom-ready.ts

Client scripts for @roots/bud

/**
 * Calls once document has loaded.
 *
 * @remarks
 * Callback function may be async or sync
 *
 * @param onReady - callback function
 * @returns void
 */
interface domReady {
  (onReady: () => (() => Promise<unknown>) | unknown): void
}

const domReady: domReady = onReady => {
  window.requestAnimationFrame(async function check() {
    document.body ? await onReady() : window.requestAnimationFrame(check)
  })
}

export default domReady