xuguopeng/rrweb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

return stopper function as the result of record

Browse Source
This commit is contained in:
Yanzhen Yu
2026-04-01 12:00:00 +08:00
parent efa7a8fa1b
commit 09f30d2a81
3 changed files with 105 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
src/record/index.ts
View File

@@ -7,6 +7,7 @@ import {
eventWithTime,
recordOptions,
IncrementalSource,
listenerHandler,
} from '../types';
function wrapEvent(e: event): eventWithTime {
@@ -16,21 +17,24 @@ function wrapEvent(e: event): eventWithTime {
};
}
function record(options: recordOptions = {}) {
function record(options: recordOptions = {}): listenerHandler | undefined {
const { emit } = options;
// runtime checks for user options
if (!emit) {
throw new Error('emit function is required');
}
try {
on('DOMContentLoaded', () => {
emit(
wrapEvent({
type: EventType.DomContentLoaded,
data: {},
}),
);
});
const handlers: listenerHandler[] = [];
handlers.push(
on('DOMContentLoaded', () => {
emit(
wrapEvent({
type: EventType.DomContentLoaded,
data: {},
}),
);
}),
);
const init = () => {
emit(
wrapEvent({
@@ -59,68 +63,70 @@ function record(options: recordOptions = {}) {
},
}),
);
initObservers({
mutationCb: m =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.Mutation,
...m,
},
}),
),
mousemoveCb: positions =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.MouseMove,
positions,
},
}),
),
mouseInteractionCb: d =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.MouseInteraction,
...d,
},
}),
),
scrollCb: p =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.Scroll,
...p,
},
}),
),
viewportResizeCb: d =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.ViewportResize,
...d,
},
}),
),
inputCb: v =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.Input,
...v,
},
}),
),
});
handlers.push(
initObservers({
mutationCb: m =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.Mutation,
...m,
},
}),
),
mousemoveCb: positions =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.MouseMove,
positions,
},
}),
),
mouseInteractionCb: d =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.MouseInteraction,
...d,
},
}),
),
scrollCb: p =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.Scroll,
...p,
},
}),
),
viewportResizeCb: d =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.ViewportResize,
...d,
},
}),
),
inputCb: v =>
emit(
wrapEvent({
type: EventType.IncrementalSnapshot,
data: {
source: IncrementalSource.Input,
...v,
},
}),
),
}),
);
};
if (
document.readyState === 'interactive' ||
@@ -128,20 +134,25 @@ function record(options: recordOptions = {}) {
) {
init();
} else {
on(
'load',
() => {
emit(
wrapEvent({
type: EventType.Load,
data: {},
}),
);
init();
},
window,
handlers.push(
on(
'load',
() => {
emit(
wrapEvent({
type: EventType.Load,
data: {},
}),
);
init();
},
window,
),
);
}
return () => {
handlers.forEach(h => h());
};
} catch (error) {
// TODO: handle internal error
console.warn(error);

16
src/record/observer.ts
View File

@@ -365,7 +365,7 @@ function initInputObserver(cb: inputCallback): listenerHandler {
};
}
export default function initObservers(o: observerParam) {
export default function initObservers(o: observerParam): listenerHandler {
const mutationObserver = initMutationObserver(o.mutationCb);
const mousemoveHandler = initMousemoveObserver(o.mousemoveCb);
const mouseInteractionHandler = initMouseInteractionObserver(
@@ -374,12 +374,12 @@ export default function initObservers(o: observerParam) {
const scrollHandler = initScrollObserver(o.scrollCb);
const viewportResizeHandler = initViewportResizeObserver(o.viewportResizeCb);
const inputHandler = initInputObserver(o.inputCb);
return {
mutationObserver,
mousemoveHandler,
mouseInteractionHandler,
scrollHandler,
viewportResizeHandler,
inputHandler,
return () => {
mutationObserver.disconnect();
mousemoveHandler();
mouseInteractionHandler();
scrollHandler();
viewportResizeHandler();
inputHandler();
};
}

5
src/utils.ts
View File

@@ -11,8 +11,9 @@ export function on(
fn: EventListenerOrEventListenerObject,
target: Document | Window = document,
): listenerHandler {
target.addEventListener(type, fn, { capture: true, passive: true });
return () => target.removeEventListener(type, fn);
const options = { capture: true, passive: true };
target.addEventListener(type, fn, options);
return () => target.removeEventListener(type, fn, options);
}
export const mirror: Mirror = {