Skip to content

Commit

Permalink
Fix types in rrwebPlayer (rrweb-io#1247)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
Juice10 authored and eoghanmurray committed Jul 27, 2023
1 parent 3310ae0 commit 88c9550
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/smooth-poems-bake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'rrweb-player': patch
---

Fix `player.getMirror`, `player.playRange`, `player.$set` types in rrwebPlayer
12 changes: 10 additions & 2 deletions packages/rrweb-player/typings/index.d.ts
Original file line number Diff line number Diff line change
@@ -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 = {
Expand Down Expand Up @@ -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;
}

0 comments on commit 88c9550

Please sign in to comment.