Skip to main content

@rtorcato/browser-common / mutationobserver

mutationobserver

Functions​

observeMutations()​

observeMutations(element, callback, options?): MutationObserver

Defined in: mutationobserver/index.ts:14

Creates a MutationObserver and starts observing the given element.

Example​

import { observeMutations, disconnectMutationObserver } from '@rtorcato/browser-common/mutationobserver'
const obs = observeMutations(document.body, (records) => console.log(records))
disconnectMutationObserver(obs)

Parameters​

element​

Node

The element to observe.

callback​

MutationCallback

The callback to run when mutations occur.

options?​

MutationObserverInit = ...

MutationObserver options.

Returns​

MutationObserver

The created MutationObserver instance.

disconnectMutationObserver()​

disconnectMutationObserver(observer): void

Defined in: mutationobserver/index.ts:33

Disconnects a MutationObserver, stopping all observations.

Example​

import { disconnectMutationObserver } from '@rtorcato/browser-common/mutationobserver'
disconnectMutationObserver(obs)

Parameters​

observer​

MutationObserver

The MutationObserver instance.

Returns​

void

observeMutationOnce()​

observeMutationOnce(element, callback, options?): MutationObserver

Defined in: mutationobserver/index.ts:49

Utility to observe an element for mutations once (fires callback only on first mutation).

Example​

import { observeMutationOnce } from '@rtorcato/browser-common/mutationobserver'
observeMutationOnce(container, () => console.log('mutated once'))

Parameters​

element​

Node

The element to observe.

callback​

MutationCallback

The callback to run on first mutation.

options?​

MutationObserverInit = ...

MutationObserver options.

Returns​

MutationObserver

The created MutationObserver instance.