blob: 8cdedca4a593a9e4de76275cd46d7ce5f1c48f30 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
/*
* Copyright (C) 2023-2024 Yomitan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
export type OnAddedCallback<T = unknown> = (element: Element) => T | undefined;
export type OnRemovedCallback<T = unknown> = (element: Element, data: T) => void;
export type OnChildrenUpdatedCallback<T = unknown> = (element: Element, data: T) => void;
export type IsStaleCallback<T = unknown> = (element: Element, data: T) => boolean;
export type ConstructorDetails<T = unknown> = {
/** A string CSS selector used to find elements. */
selector: string;
/** A string CSS selector used to filter elements, or `null` for no filtering. */
ignoreSelector?: string | null;
/** A function which is invoked for each element that is added that matches the selector. */
onAdded?: OnAddedCallback<T> | null;
/** A function which is invoked for each element that is removed, or `null`. */
onRemoved?: OnRemovedCallback<T> | null;
/** A function which is invoked for each element which has its children updated, or `null`. */
onChildrenUpdated?: OnChildrenUpdatedCallback<T> | null;
/**
* A function which checks if the data is stale for a given element, or `null`.
* If the element is stale, it will be removed and potentially re-added.
*/
isStale?: IsStaleCallback<T> | null;
};
export type MutationRecordLike = {
type: string;
addedNodes: Node[];
removedNodes: Node[];
target: Node;
};
export type Observer<T = unknown> = {
element: Element;
ancestors: Node[];
data: T;
};
|