Skip to content

Commit a01a12e

Browse files
authored
Fix types in rrwebPlayer (#1247)
* Export correct mirror in player Was using DeprecatedMirror in its types, that shouldn't be used anymore. * Add playRange to types * Create smooth-poems-bake.md * Apply formatting changes * Add $set to player type * Update smooth-poems-bake.md * Apply formatting changes * Last two arguments of playRange are optional
1 parent 490b3e2 commit a01a12e

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

.changeset/smooth-poems-bake.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'rrweb-player': patch
3+
---
4+
5+
Fix `player.getMirror`, `player.playRange`, `player.$set` types in rrwebPlayer

packages/rrweb-player/typings/index.d.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { playerConfig } from 'rrweb/typings/types';
22
import { eventWithTime } from '@rrweb/types';
3-
import { Replayer, mirror } from 'rrweb';
3+
import { Replayer } from 'rrweb';
4+
import { Mirror } from 'rrweb-snapshot';
45
import { SvelteComponent } from 'svelte';
56

67
export type RRwebPlayerOptions = {
@@ -67,13 +68,20 @@ export default class rrwebPlayer extends SvelteComponent {
6768
addEvent(event: eventWithTime): void;
6869
getMetaData: Replayer['getMetaData'];
6970
getReplayer: () => Replayer;
70-
getMirror: () => typeof mirror;
71+
getMirror: () => Mirror;
7172

7273
toggle: () => void;
7374
setSpeed: (speed: number) => void;
7475
toggleSkipInactive: () => void;
7576
triggerResize: () => void;
77+
$set: (options: { width: number; height: number }) => void;
7678
play: () => void;
7779
pause: () => void;
7880
goto: (timeOffset: number, play?: boolean) => void;
81+
playRange: (
82+
timeOffset: number,
83+
endTimeOffset: number,
84+
startLooping?: boolean,
85+
afterHook?: undefined | (() => void),
86+
) => void;
7987
}

0 commit comments

Comments
 (0)