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
This commit is contained in:
Justin Halsall
2023-06-30 02:35:38 +02:00
committed by GitHub
parent 490b3e2b62
commit a01a12ef67
2 changed files with 15 additions and 2 deletions

View File

@@ -0,0 +1,5 @@
---
'rrweb-player': patch
---
Fix `player.getMirror`, `player.playRange`, `player.$set` types in rrwebPlayer

View File

@@ -1,6 +1,7 @@
import { playerConfig } from 'rrweb/typings/types';
import { eventWithTime } from '@rrweb/types';
import { Replayer, mirror } from 'rrweb';
import { Replayer } from 'rrweb';
import { Mirror } from 'rrweb-snapshot';
import { SvelteComponent } from 'svelte';
export type RRwebPlayerOptions = {
@@ -67,13 +68,20 @@ export default class rrwebPlayer extends SvelteComponent {
addEvent(event: eventWithTime): void;
getMetaData: Replayer['getMetaData'];
getReplayer: () => Replayer;
getMirror: () => typeof mirror;
getMirror: () => Mirror;
toggle: () => void;
setSpeed: (speed: number) => void;
toggleSkipInactive: () => void;
triggerResize: () => void;
$set: (options: { width: number; height: number }) => void;
play: () => void;
pause: () => void;
goto: (timeOffset: number, play?: boolean) => void;
playRange: (
timeOffset: number,
endTimeOffset: number,
startLooping?: boolean,
afterHook?: undefined | (() => void),
) => void;
}