From a01a12ef6769f26aa922ccd6ac76499f0837f0c2 Mon Sep 17 00:00:00 2001 From: Justin Halsall Date: Fri, 30 Jun 2023 02:35:38 +0200 Subject: [PATCH] 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 --- .changeset/smooth-poems-bake.md | 5 +++++ packages/rrweb-player/typings/index.d.ts | 12 ++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 .changeset/smooth-poems-bake.md diff --git a/.changeset/smooth-poems-bake.md b/.changeset/smooth-poems-bake.md new file mode 100644 index 00000000..9d4fac8f --- /dev/null +++ b/.changeset/smooth-poems-bake.md @@ -0,0 +1,5 @@ +--- +'rrweb-player': patch +--- + +Fix `player.getMirror`, `player.playRange`, `player.$set` types in rrwebPlayer diff --git a/packages/rrweb-player/typings/index.d.ts b/packages/rrweb-player/typings/index.d.ts index b27799aa..e76b493e 100755 --- a/packages/rrweb-player/typings/index.d.ts +++ b/packages/rrweb-player/typings/index.d.ts @@ -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; }