@johngw/stream
Version:
Reactive programming tools using the WHATWG Streams API.
33 lines (32 loc) • 933 B
TypeScript
/**
* Creates a ReadableStream from DOM mutations.
*
* @group Sources
* @see {@link addedNodes:function}
* @see {@link removedNodes:function}
* @example
* ```
* fromDOMMutations(document.body, { childList: true })
* .pipeTo(write((mutation) => {
* console.info(mutation.addedNodes)
* }))
* ```
*
* If the queue is full when receiving DOM mutations, you
* may notice some events being dropped. To avoid this you
* will need to increase the high water mark.
*
* ```
* fromDOMMutations(
* document.body,
* { childList: true },
* new CountQueuingStrategy({ highWaterMark: 10 })
* )
* .pipeThrough(addedNodes())
* .pipeTo(
* write(console.info),
* new CountQueuingStrategy({ highWaterMark: 50 })
* )
* ```
*/
export declare function fromDOMMutations(target: Node, options?: MutationObserverInit, queuingStrategy?: QueuingStrategy<MutationRecord>): ReadableStream<MutationRecord>;