@types/jsdom

Version 28.0.1
Published 7 days ago
20.4 kB
4 dependencies
MIT license

Install

npm i @types/jsdom

yarn add @types/jsdom

pnpm add @types/jsdom

Overview

TypeScript definitions for jsdom

Index

Variables

variable toughCookie

const toughCookie: any;

Functions

function requestInterceptor

requestInterceptor: (
    fn: RequestInterceptorCallback
) => Dispatcher.DispatchInterceptor;

Classes

class CookieJar

class CookieJar extends tough.CookieJar {}

class JSDOM

class JSDOM {}

constructor

constructor(html?: any, options?: ConstructorOptions);

property cookieJar

readonly cookieJar: CookieJar;

property virtualConsole

readonly virtualConsole: VirtualConsole;

property window

readonly window: DOMWindow;

method fragment

static fragment: (html: string) => DocumentFragment;

method fromFile

static fromFile: (url: string, options?: FileOptions) => Promise<JSDOM>;

method fromURL

static fromURL: (url: string, options?: BaseOptions) => Promise<JSDOM>;

method getInternalVMContext

getInternalVMContext: () => Context;

The built-in vm module of Node.js is what underpins JSDOM's script-running magic. Some advanced use cases, like pre-compiling a script and then running it multiple times, benefit from using the vm module directly with a jsdom-created Window.
Throws
{TypeError} If the JSDOM instance was created without runScripts set, or if you are using JSDOM in a web browser.

method nodeLocation

nodeLocation: (node: Node) => Token.Location | null | undefined;

The nodeLocation() method will find where a DOM node is within the source document, returning the parse5 location info for the node.
Throws
{Error} If the JSDOM was not created with includeNodeLocations

method reconfigure

reconfigure: (settings: ReconfigureSettings) => void;

The reconfigure method allows changing the window.top and url from the outside.

method serialize

serialize: () => string;

The serialize() method will return the HTML serialization of the document, including the doctype.

class VirtualConsole

class VirtualConsole extends EventEmitter {}

method forwardTo

forwardTo: (console: Console, options?: VirtualConsoleForwardToOptions) => this;

method on

on: {
    <K extends keyof Console>(method: K, callback: Console[K]): this;
    (event: 'jsdomError', callback: (e: Error) => void): this;
};

Interfaces

interface AbortablePromise

interface AbortablePromise<T> extends Promise<T> {}

method abort

abort: () => void;

interface BaseOptions

interface BaseOptions {}

property cookieJar

cookieJar?: CookieJar | undefined;

property includeNodeLocations

includeNodeLocations?: boolean | undefined;

includeNodeLocations preserves the location info produced by the HTML parser, allowing you to retrieve it with the nodeLocation() method (described below).
It defaults to false to give the best performance, and cannot be used with an XML content type since our XML parser does not support location info.
false

property pretendToBeVisual

pretendToBeVisual?: boolean | undefined;

jsdom does not have the capability to render visual content, and will act like a headless browser by default. It provides hints to web pages through APIs such as document.hidden that their content is not visible.
When the pretendToBeVisual option is set to true, jsdom will pretend that it is rendering and displaying content.
false

property referrer

referrer?: string | undefined;

referrer just affects the value read from document.referrer. It defaults to no referrer (which reflects as the empty string).

property resources

resources?: 'usable' | ResourcesOptions | undefined;

property runScripts

runScripts?: 'dangerously' | 'outside-only' | undefined;

property virtualConsole

virtualConsole?: VirtualConsole | undefined;

method beforeParse

beforeParse: (window: DOMWindow) => void;

interface ConstructorOptions

interface ConstructorOptions extends BaseOptions {}

property contentType

contentType?: string | undefined;

contentType affects the value read from document.contentType, and how the document is parsed: as HTML or as XML. Values that are not "text/html" or an XML mime type will throw. It defaults to "text/html".

property storageQuota

storageQuota?: number | undefined;

The maximum size in code units for the separate storage areas used by localStorage and sessionStorage. Attempts to store data larger than this limit will cause a DOMException to be thrown. By default, it is set to 5,000,000 code units per origin, as inspired by the HTML specification.
5_000_000

property url

url?: string | undefined;

url sets the value returned by window.location, document.URL, and document.documentURI, and affects things like resolution of relative URLs within the document and the same-origin restrictions and referrer used while fetching subresources. It defaults to "about:blank".

interface DOMWindow

interface DOMWindow extends Omit<Window, 'top' | 'self' | 'window'> {}

property ["Infinity"]

readonly ['Infinity']: number;

property ["NaN"]

readonly ['NaN']: number;

property AbortController

AbortController: typeof AbortController;

property AbortSignal

AbortSignal: typeof AbortSignal;

property AbstractRange

AbstractRange: typeof AbstractRange;

property Array

Array: typeof Array;

property ArrayBuffer

ArrayBuffer: typeof ArrayBuffer;

property Atomics

Atomics: typeof Atomics;

property Attr

Attr: typeof Attr;

property BarProp

BarProp: typeof BarProp;

property BigInt

BigInt: typeof BigInt;

property BigInt64Array

BigInt64Array: typeof BigInt64Array;

property BigUint64Array

BigUint64Array: typeof BigUint64Array;

property Blob

Blob: typeof Blob;

property Boolean

Boolean: typeof Boolean;

property CDATASection

CDATASection: typeof CDATASection;

property CharacterData

CharacterData: typeof CharacterData;

property CloseEvent

CloseEvent: typeof CloseEvent;

property Comment

Comment: typeof Comment;

property CompositionEvent

CompositionEvent: typeof CompositionEvent;

property CSSImportRule

CSSImportRule: typeof CSSImportRule;

property CSSMediaRule

CSSMediaRule: typeof CSSMediaRule;

property CSSRule

CSSRule: typeof CSSRule;

property CSSStyleDeclaration

CSSStyleDeclaration: typeof CSSStyleDeclaration;

property CSSStyleRule

CSSStyleRule: typeof CSSStyleRule;

property CSSStyleSheet

CSSStyleSheet: typeof CSSStyleSheet;

property CustomElementRegistry

CustomElementRegistry: typeof CustomElementRegistry;

property CustomEvent

CustomEvent: typeof CustomEvent;

property DataView

DataView: typeof DataView;

property Date

Date: typeof Date;

property Document

Document: typeof Document;

property DocumentFragment

DocumentFragment: typeof DocumentFragment;

property DocumentType

DocumentType: typeof DocumentType;

property DOMException

DOMException: typeof DOMException;

property DOMImplementation

DOMImplementation: typeof DOMImplementation;

property DOMParser

DOMParser: typeof DOMParser;

property DOMStringMap

DOMStringMap: typeof DOMStringMap;

property DOMTokenList

DOMTokenList: typeof DOMTokenList;

property Element

Element: typeof Element;

property Error

Error: typeof Error;

property ErrorEvent

ErrorEvent: typeof ErrorEvent;

property EvalError

EvalError: typeof EvalError;

property Event

Event: typeof Event;

property EventTarget

EventTarget: typeof EventTarget;

property External

External: typeof External;

property File

File: typeof File;

property FileList

FileList: typeof FileList;

property FileReader

FileReader: typeof FileReader;

property FinalizationRegistry

FinalizationRegistry: FinalizationRegistryConstructor;

property Float32Array

Float32Array: typeof Float32Array;

property Float64Array

Float64Array: typeof Float64Array;

property FocusEvent

FocusEvent: typeof FocusEvent;

property FormData

FormData: typeof FormData;

property Function

Function: typeof Function;

property globalThis

globalThis: DOMWindow;

property HashChangeEvent

HashChangeEvent: typeof HashChangeEvent;

property Headers

Headers: typeof Headers;

property History

History: typeof History;

property HTMLAnchorElement

HTMLAnchorElement: typeof HTMLAnchorElement;

property HTMLAreaElement

HTMLAreaElement: typeof HTMLAreaElement;

property HTMLAudioElement

HTMLAudioElement: typeof HTMLAudioElement;

property HTMLBaseElement

HTMLBaseElement: typeof HTMLBaseElement;

property HTMLBodyElement

HTMLBodyElement: typeof HTMLBodyElement;

property HTMLBRElement

HTMLBRElement: typeof HTMLBRElement;

property HTMLButtonElement

HTMLButtonElement: typeof HTMLButtonElement;

property HTMLCanvasElement

HTMLCanvasElement: typeof HTMLCanvasElement;

property HTMLCollection

HTMLCollection: typeof HTMLCollection;

property HTMLDataElement

HTMLDataElement: typeof HTMLDataElement;

property HTMLDataListElement

HTMLDataListElement: typeof HTMLDataListElement;

property HTMLDetailsElement

HTMLDetailsElement: typeof HTMLDetailsElement;

property HTMLDialogElement

HTMLDialogElement: {
    new (): HTMLDialogElement;
    readonly prototype: HTMLDialogElement;
};

property HTMLDirectoryElement

HTMLDirectoryElement: typeof HTMLDirectoryElement;

property HTMLDivElement

HTMLDivElement: typeof HTMLDivElement;

property HTMLDListElement

HTMLDListElement: typeof HTMLDListElement;

property HTMLDocument

HTMLDocument: typeof HTMLDocument;

property HTMLElement

HTMLElement: typeof HTMLElement;

property HTMLEmbedElement

HTMLEmbedElement: typeof HTMLEmbedElement;

property HTMLFieldSetElement

HTMLFieldSetElement: typeof HTMLFieldSetElement;

property HTMLFontElement

HTMLFontElement: typeof HTMLFontElement;

property HTMLFormElement

HTMLFormElement: typeof HTMLFormElement;

property HTMLFrameElement

HTMLFrameElement: typeof HTMLFrameElement;

property HTMLFrameSetElement

HTMLFrameSetElement: typeof HTMLFrameSetElement;

property HTMLHeadElement

HTMLHeadElement: typeof HTMLHeadElement;

property HTMLHeadingElement

HTMLHeadingElement: typeof HTMLHeadingElement;

property HTMLHRElement

HTMLHRElement: typeof HTMLHRElement;

property HTMLHtmlElement

HTMLHtmlElement: typeof HTMLHtmlElement;

property HTMLIFrameElement

HTMLIFrameElement: typeof HTMLIFrameElement;

property HTMLImageElement

HTMLImageElement: typeof HTMLImageElement;

property HTMLInputElement

HTMLInputElement: typeof HTMLInputElement;

property HTMLLabelElement

HTMLLabelElement: typeof HTMLLabelElement;

property HTMLLegendElement

HTMLLegendElement: typeof HTMLLegendElement;

property HTMLLIElement

HTMLLIElement: typeof HTMLLIElement;

property HTMLLinkElement

HTMLLinkElement: typeof HTMLLinkElement;

property HTMLMapElement

HTMLMapElement: typeof HTMLMapElement;

property HTMLMarqueeElement

HTMLMarqueeElement: typeof HTMLMarqueeElement;

property HTMLMediaElement

HTMLMediaElement: typeof HTMLMediaElement;

property HTMLMenuElement

HTMLMenuElement: typeof HTMLMenuElement;

property HTMLMetaElement

HTMLMetaElement: typeof HTMLMetaElement;

property HTMLMeterElement

HTMLMeterElement: typeof HTMLMeterElement;

property HTMLModElement

HTMLModElement: typeof HTMLModElement;

property HTMLObjectElement

HTMLObjectElement: typeof HTMLObjectElement;

property HTMLOListElement

HTMLOListElement: typeof HTMLOListElement;

property HTMLOptGroupElement

HTMLOptGroupElement: typeof HTMLOptGroupElement;

property HTMLOptionElement

HTMLOptionElement: typeof HTMLOptionElement;

property HTMLOptionsCollection

HTMLOptionsCollection: typeof HTMLOptionsCollection;

property HTMLOutputElement

HTMLOutputElement: typeof HTMLOutputElement;

property HTMLParagraphElement

HTMLParagraphElement: typeof HTMLParagraphElement;

property HTMLParamElement

HTMLParamElement: typeof HTMLParamElement;

property HTMLPictureElement

HTMLPictureElement: typeof HTMLPictureElement;

property HTMLPreElement

HTMLPreElement: typeof HTMLPreElement;

property HTMLProgressElement

HTMLProgressElement: typeof HTMLProgressElement;

property HTMLQuoteElement

HTMLQuoteElement: typeof HTMLQuoteElement;

property HTMLScriptElement

HTMLScriptElement: typeof HTMLScriptElement;

property HTMLSelectElement

HTMLSelectElement: typeof HTMLSelectElement;

property HTMLSlotElement

HTMLSlotElement: typeof HTMLSlotElement;

property HTMLSourceElement

HTMLSourceElement: typeof HTMLSourceElement;

property HTMLSpanElement

HTMLSpanElement: typeof HTMLSpanElement;

property HTMLStyleElement

HTMLStyleElement: typeof HTMLStyleElement;

property HTMLTableCaptionElement

HTMLTableCaptionElement: typeof HTMLTableCaptionElement;

property HTMLTableCellElement

HTMLTableCellElement: typeof HTMLTableCellElement;

property HTMLTableColElement

HTMLTableColElement: typeof HTMLTableColElement;

property HTMLTableElement

HTMLTableElement: typeof HTMLTableElement;

property HTMLTableRowElement

HTMLTableRowElement: typeof HTMLTableRowElement;

property HTMLTableSectionElement

HTMLTableSectionElement: typeof HTMLTableSectionElement;

property HTMLTemplateElement

HTMLTemplateElement: typeof HTMLTemplateElement;

property HTMLTextAreaElement

HTMLTextAreaElement: typeof HTMLTextAreaElement;

property HTMLTimeElement

HTMLTimeElement: typeof HTMLTimeElement;

property HTMLTitleElement

HTMLTitleElement: typeof HTMLTitleElement;

property HTMLTrackElement

HTMLTrackElement: typeof HTMLTrackElement;

property HTMLUListElement

HTMLUListElement: typeof HTMLUListElement;

property HTMLUnknownElement

HTMLUnknownElement: typeof HTMLUnknownElement;

property HTMLVideoElement

HTMLVideoElement: typeof HTMLVideoElement;

property InputEvent

InputEvent: typeof InputEvent;

property Int16Array

Int16Array: typeof Int16Array;

property Int32Array

Int32Array: typeof Int32Array;

property Int8Array

Int8Array: typeof Int8Array;

property Intl

Intl: typeof Intl;

property JSON

JSON: typeof JSON;

property KeyboardEvent

KeyboardEvent: typeof KeyboardEvent;

property Location

Location: typeof Location;

property Map

Map: typeof Map;

property Math

Math: typeof Math;

property MediaList

MediaList: typeof MediaList;

property MessageEvent

MessageEvent: typeof MessageEvent;

property MimeType

MimeType: typeof MimeType;

property MimeTypeArray

MimeTypeArray: typeof MimeTypeArray;

property MouseEvent

MouseEvent: typeof MouseEvent;

property MutationObserver

MutationObserver: typeof MutationObserver;

property MutationRecord

MutationRecord: typeof MutationRecord;

property NamedNodeMap

NamedNodeMap: typeof NamedNodeMap;

property Navigator

Navigator: typeof Navigator;

property Node

Node: typeof Node;

property NodeFilter

NodeFilter: typeof NodeFilter;

property NodeIterator

NodeIterator: typeof NodeIterator;

property NodeList

NodeList: typeof NodeList;

property Number

Number: typeof Number;

property Object

Object: typeof Object;

property PageTransitionEvent

PageTransitionEvent: typeof PageTransitionEvent;

property Performance

Performance: typeof Performance;

property Plugin

Plugin: typeof Plugin;

property PluginArray

PluginArray: typeof PluginArray;

property PopStateEvent

PopStateEvent: typeof PopStateEvent;

property ProcessingInstruction

ProcessingInstruction: typeof ProcessingInstruction;

property ProgressEvent

ProgressEvent: typeof ProgressEvent;

property Promise

Promise: typeof Promise;

property Proxy

Proxy: typeof Proxy;

property Range

Range: typeof Range;

property RangeError

RangeError: typeof RangeError;

property ReferenceError

ReferenceError: typeof ReferenceError;

property Reflect

Reflect: typeof Reflect;

property RegExp

RegExp: typeof RegExp;

property Screen

Screen: typeof Screen;

property Selection

Selection: typeof Selection;

property self

readonly self: DOMWindow;

property Set

Set: typeof Set;

property ShadowRoot

ShadowRoot: typeof ShadowRoot;

property SharedArrayBuffer

SharedArrayBuffer: typeof SharedArrayBuffer;

property StaticRange

StaticRange: typeof StaticRange;

property Storage

Storage: typeof Storage;

property StorageEvent

StorageEvent: typeof StorageEvent;

property String

String: typeof String;

property StyleSheet

StyleSheet: typeof StyleSheet;

property StyleSheetList

StyleSheetList: typeof StyleSheetList;

property SVGAnimatedString

SVGAnimatedString: typeof SVGAnimatedString;

property SVGElement

SVGElement: typeof SVGElement;

property SVGGraphicsElement

SVGGraphicsElement: typeof SVGGraphicsElement;

property SVGNumber

SVGNumber: typeof SVGNumber;

property SVGStringList

SVGStringList: typeof SVGStringList;

property SVGSVGElement

SVGSVGElement: typeof SVGSVGElement;

property SVGTitleElement

SVGTitleElement: typeof SVGTitleElement;

property Symbol

Symbol: typeof Symbol;

property SyntaxError

SyntaxError: typeof SyntaxError;

property Text

Text: typeof Text;

property top

readonly top: DOMWindow;

property TouchEvent

TouchEvent: typeof TouchEvent;

property TreeWalker

TreeWalker: typeof TreeWalker;

property TypeError

TypeError: typeof TypeError;

property UIEvent

UIEvent: typeof UIEvent;

property Uint16Array

Uint16Array: typeof Uint16Array;

property Uint32Array

Uint32Array: typeof Uint32Array;

property Uint8Array

Uint8Array: typeof Uint8Array;

property Uint8ClampedArray

Uint8ClampedArray: typeof Uint8ClampedArray;

property undefined

readonly undefined: undefined;

property URIError

URIError: typeof URIError;

property URL

URL: typeof URL;

property URLSearchParams

URLSearchParams: typeof URLSearchParams;

property ValidityState

ValidityState: typeof ValidityState;

property WeakMap

WeakMap: typeof WeakMap;

property WeakRef

WeakRef: WeakRefConstructor;

property WeakSet

WeakSet: typeof WeakSet;

property WebAssembly

WebAssembly: typeof WebAssembly;

property WebSocket

WebSocket: typeof WebSocket;

property WheelEvent

WheelEvent: typeof WheelEvent;

property window

readonly window: DOMWindow;

property Window

Window: typeof Window;

property XMLDocument

XMLDocument: typeof XMLDocument;

property XMLHttpRequest

XMLHttpRequest: typeof XMLHttpRequest;

property XMLHttpRequestEventTarget

XMLHttpRequestEventTarget: typeof XMLHttpRequestEventTarget;

property XMLHttpRequestUpload

XMLHttpRequestUpload: typeof XMLHttpRequestUpload;

property XMLSerializer

XMLSerializer: typeof XMLSerializer;

property XPathEvaluator

XPathEvaluator: typeof XPathEvaluator;

property XPathExpression

XPathExpression: typeof XPathExpression;

property XPathResult

XPathResult: typeof XPathResult;

method decodeURI

decodeURI: (encodedURI: string) => string;

method decodeURIComponent

decodeURIComponent: (encodedURIComponent: string) => string;

method encodeURI

encodeURI: (uri: string) => string;

method encodeURIComponent

encodeURIComponent: (uriComponent: string | number | boolean) => string;

method escape

escape: (string: string) => string;

method eval

eval: (script: string) => unknown;

method isFinite

isFinite: (number: number) => boolean;

method isNaN

isNaN: (number: number) => boolean;

method parseFloat

parseFloat: (string: string) => number;

method parseInt

parseInt: (s: string, radix?: number) => number;

method unescape

unescape: (string: string) => string;

index signature

[key: string]: any;

index signature

[index: number]: any;

interface FileOptions

interface FileOptions extends BaseOptions {}

property contentType

contentType?: string | undefined;

contentType affects the value read from document.contentType, and how the document is parsed: as HTML or as XML. Values that are not "text/html" or an XML mime type will throw. It will default to "application/xhtml+xml" if the given filename ends in .xhtml or .xml; otherwise it will continue to default to "text/html".

property url

url?: string | undefined;

url sets the value returned by window.location, document.URL, and document.documentURI, and affects things like resolution of relative URLs within the document and the same-origin restrictions and referrer used while fetching subresources. It will default to a file URL corresponding to the given filename, instead of to "about:blank".

interface ReconfigureSettings

interface ReconfigureSettings {}

property url

url?: string | undefined;

property windowTop

windowTop?: DOMWindow | undefined;

interface RequestInterceptorContext

interface RequestInterceptorContext {}

property element

element: HTMLElement | null;

interface ResourcesOptions

interface ResourcesOptions {}

property dispatcher

dispatcher?: Dispatcher | undefined;

property interceptors

interceptors?: Dispatcher.DispatcherComposeInterceptor[] | undefined;

property userAgent

userAgent?: string | undefined;

userAgent affects the value read from navigator.userAgent, as well as the User-Agent header sent while fetching subresources.
Mozilla/5.0 (${process.platform}) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/${jsdomVersion}

interface VirtualConsoleForwardToOptions

interface VirtualConsoleForwardToOptions {}

property jsdomErrors

jsdomErrors?: JSDOMError[] | 'none' | undefined;

Type Aliases

type BinaryData

type BinaryData = ArrayBufferLike | NodeJS.ArrayBufferView;

type JSDOMError

type JSDOMError =
    | 'css-parsing'
    | 'not-implemented'
    | 'resource-loading'
    | 'unhandled-exception';

type RequestInterceptorCallback

type RequestInterceptorCallback = (
    request: Request,
    context: RequestInterceptorContext
    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
) => void | undefined | Response | Promise<undefined | Response>;

type SupportedContentTypes

type SupportedContentTypes =
    | 'text/html'
    | 'application/xhtml+xml'
    | 'application/xml'
    | 'text/xml'
    | 'image/svg+xml';

Namespaces

namespace global

namespace global {}

interface FinalizationRegistryConstructor

interface FinalizationRegistryConstructor {}

interface WeakRefConstructor

interface WeakRefConstructor {}

Package Files (1)

index.d.ts

Dependencies (4)

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/jsdom.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/jsdom)

HTML

<a href="https://www.jsdocs.io/package/@types/jsdom"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 6 days ago.
Package analyzed in 5409 ms.
Missing or incorrect documentation? Open an issue for this package.

@types/jsdom

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Type Aliases

Namespaces

Variables

variable toughCookie

Functions

function requestInterceptor

Classes

class CookieJar

class JSDOM

constructor

property cookieJar

property virtualConsole

property window

method fragment

method fromFile

method fromURL

method getInternalVMContext

Throws

method nodeLocation

Throws

method reconfigure

method serialize

class VirtualConsole

method forwardTo

method on

Interfaces

interface AbortablePromise

method abort

interface BaseOptions

property cookieJar

property includeNodeLocations

property pretendToBeVisual

property referrer

property resources

property runScripts

property virtualConsole

method beforeParse

interface ConstructorOptions

property contentType

property storageQuota

property url

interface DOMWindow

property ["Infinity"]

property ["NaN"]

property AbortController

property AbortSignal

property AbstractRange

property Array

property ArrayBuffer

property Atomics

property Attr

property BarProp

property BigInt

property BigInt64Array

property BigUint64Array

property Blob

property Boolean

property CDATASection

property CharacterData

property CloseEvent

property Comment

property CompositionEvent

property CSSImportRule

property CSSMediaRule

property CSSRule

property CSSStyleDeclaration

property CSSStyleRule

property CSSStyleSheet

property CustomElementRegistry

property CustomEvent

property DataView

property Date