diff --git a/docs/recipes/console.md b/docs/recipes/console.md index eb7b9a15e1..de2f84e03a 100644 --- a/docs/recipes/console.md +++ b/docs/recipes/console.md @@ -85,7 +85,7 @@ replayer.play(); Description of replay option is as follows: -| key | default | description | -| ------------ | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| level | ['log','warn','error',...] | You can set this option to play levels of log you need. | -| replayLogger | a console based object that implements the interface [ReplayLogger](../../packages/rrweb/src/plugins/console/replay/index.ts#L13) | You can also set a replay logger to replay the log messages in a simulated browser console by implementing the interface `ReplayLogger` | +| key | default | description | +| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| level | ['log','warn','error',...] | You can set this option to play levels of log you need. | +| replayLogger | a console based object that implements the interface [ReplayLogger](../../packages/plugins/rrweb-plugin-console-replay/src/index.ts#L14) | You can also set a replay logger to replay the log messages in a simulated browser console by implementing the interface `ReplayLogger` | diff --git a/docs/recipes/console.zh_CN.md b/docs/recipes/console.zh_CN.md index 42d0c08c92..52f3255fec 100644 --- a/docs/recipes/console.zh_CN.md +++ b/docs/recipes/console.zh_CN.md @@ -84,7 +84,7 @@ replayer.play(); 如下是对 replay 选项的描述: -| key | 默认值 | 功能 | -| ------------ | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| level | ['log','warn','error',...] | 你可以只播放想要的 console 函数类型 | -| replayLogger | 一个基于 console 的对接口[ReplayLogger](../../packages/rrweb/src/plugins/console/replay/index.ts#L13)的实现 | 你也可以通过传入一个`ReplayLogger`接口的自己的实现,用 html 模拟一个浏览器控制台,来播放录制的 console 数据 | +| key | 默认值 | 功能 | +| ------------ | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | +| level | ['log','warn','error',...] | 你可以只播放想要的 console 函数类型 | +| replayLogger | 一个基于 console 的对接口[ReplayLogger](../../packages/plugins/rrweb-plugin-console-replay/src/index.ts#L14)的实现 | 你也可以通过传入一个`ReplayLogger`接口的自己的实现,用 html 模拟一个浏览器控制台,来播放录制的 console 数据 | diff --git a/docs/recipes/dive-into-event.md b/docs/recipes/dive-into-event.md index be63972a68..fce28b1b3b 100644 --- a/docs/recipes/dive-into-event.md +++ b/docs/recipes/dive-into-event.md @@ -28,7 +28,7 @@ type -> EventType.Custom event -> customEvent ``` -The EventType is Typescript's numeric enum, which is a self-increased number from 0 in runtime. You can find its definition in this [list](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L10). +The EventType is Typescript's numeric enum, which is a self-increased number from 0 in runtime. You can find its definition in this [list](../../packages/types/src/index.ts#L1). In these kinds of events, the incrementalSnapshotEvent is the event that contains incremental data. You can use `event.data.source` to find which kind of incremental data it belongs to: @@ -67,4 +67,4 @@ source -> IncrementalSource.Font data -> fontData ``` -enum IncrementalSource's definition can be found in this [list](https://github.com/rrweb-io/rrweb/blob/98e71cd0d23628cd1fbdbe47664a65748084c4a4/packages/types/src/index.ts#L69). +enum IncrementalSource's definition can be found in this [list](../../packages/types/src/index.ts#L62). diff --git a/docs/recipes/dive-into-event.zh_CN.md b/docs/recipes/dive-into-event.zh_CN.md index b41242875e..18f50c22ba 100644 --- a/docs/recipes/dive-into-event.zh_CN.md +++ b/docs/recipes/dive-into-event.zh_CN.md @@ -28,7 +28,7 @@ type -> EventType.Custom event -> customEvent ``` -其中 EventType 是 Typescipt 的 numeric enum,在运行时是从 0 开始的数字,其类型定义详见[列表](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L10)。 +其中 EventType 是 Typescipt 的 numeric enum,在运行时是从 0 开始的数字,其类型定义详见[列表](../../packages/types/src/index.ts#L1)。 其中 incrementalSnapshotEvent 代表增量数据,其具体增量类型可以通过 `event.data.source` 字段进行判断: @@ -67,4 +67,4 @@ source -> IncrementalSource.Font data -> fontData ``` -enum IncrementalSource 的定义详见[列表](https://github.com/rrweb-io/rrweb/blob/master/src/types.ts#L64)。 +enum IncrementalSource 的定义详见[列表](../../packages/types/src/index.ts#L62)。 diff --git a/docs/recipes/plugin.md b/docs/recipes/plugin.md index d322bc1eaf..458108b8f8 100644 --- a/docs/recipes/plugin.md +++ b/docs/recipes/plugin.md @@ -4,12 +4,12 @@ The plugin API is designed to extend the function of rrweb without bump the size # Available plugins -- [@rrweb/rrweb-plugin-console-record](packages/plugins/rrweb-plugin-console-record): A plugin for recording console logs. -- [@rrweb/rrweb-plugin-console-replay](packages/plugins/rrweb-plugin-console-replay): A plugin for replaying console logs. -- [@rrweb/rrweb-plugin-sequential-id-record](packages/plugins/rrweb-plugin-sequential-id-record): A plugin for recording sequential IDs. -- [@rrweb/rrweb-plugin-sequential-id-replay](packages/plugins/rrweb-plugin-sequential-id-replay): A plugin for replaying sequential IDs. -- [@rrweb/rrweb-plugin-canvas-webrtc-record](packages/plugins/rrweb-plugin-canvas-webrtc-record): A plugin for stream `` via WebRTC. -- [@rrweb/rrweb-plugin-canvas-webrtc-replay](packages/plugins/rrweb-plugin-canvas-webrtc-replay): A plugin for playing streamed `` via WebRTC. +- [@rrweb/rrweb-plugin-console-record](../../packages/plugins/rrweb-plugin-console-record): A plugin for recording console logs. +- [@rrweb/rrweb-plugin-console-replay](../../packages/plugins/rrweb-plugin-console-replay): A plugin for replaying console logs. +- [@rrweb/rrweb-plugin-sequential-id-record](../../packages/plugins/rrweb-plugin-sequential-id-record): A plugin for recording sequential IDs. +- [@rrweb/rrweb-plugin-sequential-id-replay](../../packages/plugins/rrweb-plugin-sequential-id-replay): A plugin for replaying sequential IDs. +- [@rrweb/rrweb-plugin-canvas-webrtc-record](../../packages/plugins/rrweb-plugin-canvas-webrtc-record): A plugin for stream `` via WebRTC. +- [@rrweb/rrweb-plugin-canvas-webrtc-replay](../../packages/plugins/rrweb-plugin-canvas-webrtc-replay): A plugin for playing streamed `` via WebRTC. ## Interface diff --git a/docs/recipes/plugin.zh_CN.md b/docs/recipes/plugin.zh_CN.md index 806e4e228c..c2e5ad01b4 100644 --- a/docs/recipes/plugin.zh_CN.md +++ b/docs/recipes/plugin.zh_CN.md @@ -4,12 +4,12 @@ # 可用插件 -- [@rrweb/rrweb-plugin-console-record](packages/plugins/rrweb-plugin-console-record):一个用于记录控制台日志的插件。 -- [@rrweb/rrweb-plugin-console-replay](packages/plugins/rrweb-plugin-console-replay):一个用于回放控制台日志的插件。 -- [@rrweb/rrweb-plugin-sequential-id-record](packages/plugins/rrweb-plugin-sequential-id-record):一个用于记录顺序 ID 的插件。 -- [@rrweb/rrweb-plugin-sequential-id-replay](packages/plugins/rrweb-plugin-sequential-id-replay):一个用于回放顺序 ID 的插件。 -- [@rrweb/rrweb-plugin-canvas-webrtc-record](packages/plugins/rrweb-plugin-canvas-webrtc-record):一个用于通过 WebRTC 流式传输 `` 的插件。 -- [@rrweb/rrweb-plugin-canvas-webrtc-replay](packages/plugins/rrweb-plugin-canvas-webrtc-replay):一个用于通过 WebRTC 播放流式 `` 的插件。 +- [@rrweb/rrweb-plugin-console-record](../../packages/plugins/rrweb-plugin-console-record):一个用于记录控制台日志的插件。 +- [@rrweb/rrweb-plugin-console-replay](../../packages/plugins/rrweb-plugin-console-replay):一个用于回放控制台日志的插件。 +- [@rrweb/rrweb-plugin-sequential-id-record](../../packages/plugins/rrweb-plugin-sequential-id-record):一个用于记录顺序 ID 的插件。 +- [@rrweb/rrweb-plugin-sequential-id-replay](../../packages/plugins/rrweb-plugin-sequential-id-replay):一个用于回放顺序 ID 的插件。 +- [@rrweb/rrweb-plugin-canvas-webrtc-record](../../packages/plugins/rrweb-plugin-canvas-webrtc-record):一个用于通过 WebRTC 流式传输 `` 的插件。 +- [@rrweb/rrweb-plugin-canvas-webrtc-replay](../../packages/plugins/rrweb-plugin-canvas-webrtc-replay):一个用于通过 WebRTC 播放流式 `` 的插件。 ## 接口