poopoodom v0.1.1

PooPooDom

Type declarations of dom lib.

Why and When

You are developing in a non-browser environment, but you need typings of DOM. Perhaps you are using puppeteer.

You may consider to use dom lib. However, it inserts lots of globals. So dirty!

Usage

import type { Document, HTMLElement } from 'poopoodom'  // ✓ good
// import { Document, HTMLElement } from 'poopoodom'    // ✗ bad

function getElementByIdAndCheck<Element extends HTMLElement>(
    document: Document,
    id: string
): Element {
    const element = document.getElementById(id)
    if (element === null) {
        throw new Error(`Element not found: ${id}`)
    }
    return element as Element
}

Always import types only: This package assumes everything is available at runtime and does not provide any implementation.

Modern browsers now provide dom.iterable API. To use it, import whatever you need from poopoodom/iterable. Note that types from poopoodom and poopoodom/iterable are irrelevant.

import type { Document as OldDocument, HTMLElement as OldHTMLElement } from 'poopoodom'
import type { Document, HTMLElement } from 'poopoodom/iterable'

function getWideElementsInOldBrowser(document: OldDocument): OldHTMLElement[] {
  const elements = document.body.querySelectorAll<OldHTMLElement>('*')
  const ret: OldHTMLElement[] = []
  for (let i = 0; i < elements.length; i++) {
    if (elements[i].offsetWidth > 1000) {
      ret.push(elements[i])
    }
  }
  return ret
}

function getWideElementsInModernBrowser(document: Document): HTMLElement[] {
  const elements = document.body.querySelectorAll<HTMLElement>('*')
  const ret: HTMLElement[] = []
  for (const element of elements) {
    if (element.offsetWidth > 1000) {
      ret.push(element)
    }
  }
  return ret
}

Working with ESLint

Add a typescript-eslint rule to prevent accidentally importing non-type elements.

// .eslintrc.cjs
module.exports = {
  rules: {
    '@typescript-eslint/no-restricted-imports': ['error', {
      paths: [{
        name: 'poopoodom',
        allowTypeImports: true
      }]
    }]
  }
}