From 941db0f29afe15090af7c49b81f0947c661aa334 Mon Sep 17 00:00:00 2001 From: David Ortner Date: Thu, 7 Sep 2023 13:23:52 +0200 Subject: [PATCH] #1047@patch: Fixes documentation for packages in README.md. --- README.md | 6 ++++-- packages/uncaught-exception-observer/README.md | 2 +- packages/uncaught-exception-observer/package.json | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ea0bcc217..1b2854a84 100644 --- a/README.md +++ b/README.md @@ -63,11 +63,13 @@ This package makes it possible to use Happy DOM with [Jest](https://jestjs.io/). ### [![Published on npm](https://img.shields.io/npm/v/@happy-dom/global-registrator.svg)](https://www.npmjs.com/package/@happy-dom/global-registrator) [global-registrator](https://github.com/capricorn86/happy-dom/tree/master/packages/global-registrator) +A utility that registers Happy DOM globally, which makes it possible to use Happy DOM for testing in a Node environment. + --- -### [![Published on npm](https://img.shields.io/npm/v/@happy-dom/uncaught-exception-observer.svg)](https://www.npmjs.com/package/@happy-dom/uncaught-exception-observer) [global-registrator](https://github.com/capricorn86/happy-dom/tree/master/packages/uncaught-exception-observer) +### [![Published on npm](https://img.shields.io/npm/v/@happy-dom/uncaught-exception-observer.svg)](https://www.npmjs.com/package/@happy-dom/uncaught-exception-observer) [uncaught-exception-observer](https://github.com/capricorn86/happy-dom/tree/master/packages/uncaught-exception-observer) -A utility that registers Happy DOM globally, which makes it possible to use Happy DOM for testing in a Node environment. +A utility for observing uncaught exceptions thrown in Happy DOM and dispatch them as events on the Happy DOM window. # Performance diff --git a/packages/uncaught-exception-observer/README.md b/packages/uncaught-exception-observer/README.md index a0c8317b0..4ebb51d48 100644 --- a/packages/uncaught-exception-observer/README.md +++ b/packages/uncaught-exception-observer/README.md @@ -8,7 +8,7 @@ The goal of [Happy DOM](https://github.com/capricorn86/happy-dom) is to emulate [Happy DOM](https://github.com/capricorn86/happy-dom) focuses heavily on performance and can be used as an alternative to [JSDOM](https://github.com/jsdom/jsdom). -This package contains a tool that observes uncaught exceptions and Promise rejections in [Happy DOM](https://github.com/capricorn86/happy-dom). It will dispatch uncaught errors as events on the [Happy DOM](https://github.com/capricorn86/happy-dom) Window instance. +This package contains a tool that can observe uncaught exceptions and Promise rejections in [Happy DOM](https://github.com/capricorn86/happy-dom). It will dispatch uncaught errors as events on the [Happy DOM](https://github.com/capricorn86/happy-dom) Window instance. Uncaught exceptions and rejections must be listened to on the NodeJS process at a global level. This tool will therefore not work in all environments as there may already be listeners added by other libraries on the NodeJS process that may conflict. diff --git a/packages/uncaught-exception-observer/package.json b/packages/uncaught-exception-observer/package.json index 746736738..c7e71a62d 100644 --- a/packages/uncaught-exception-observer/package.json +++ b/packages/uncaught-exception-observer/package.json @@ -5,7 +5,7 @@ "homepage": "https://github.com/capricorn86/happy-dom/tree/master/packages/uncaught-exception-observer", "repository": "https://github.com/capricorn86/happy-dom", "author": "David Ortner", - "description": "Observes uncaught exceptions thrown in Happy DOM and dispatches them as events on the Happy DOM window.", + "description": "A utility for observing uncaught exceptions thrown in Happy DOM and dispatch them as events on the Happy DOM window.", "main": "lib/index.js", "type": "module", "exports": {