Fix PlaybackErrorEvent error TS typing (Dash-Industry-Forum#4363)

`PlaybackErrorEvent` when triggered in `PlaybackController`, attaches the original `MediaError` as `error` property. This commit corrects the TS typing to reflect that.
bbc · Feb 14, 2024 · 0a6b34d · 0a6b34d
1 parent 15ec5c3
commit 0a6b34d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1847,7 +1847,7 @@ declare namespace dashjs {
 
     export interface PlaybackErrorEvent extends Event {
         type: MediaPlayerEvents['PLAYBACK_ERROR'];
-        error: string;
+        error: MediaError;
     }
 
     export interface PlaybackPausedEvent extends Event {
@@ -4465,4 +4465,3 @@ declare namespace dashjs {
     export type ResponseFilter = (response: LicenseResponse) => Promise<any>;
 }
 
-
diff --git a/test/unit/streaming.controllers.PlaybackControllers.js b/test/unit/streaming.controllers.PlaybackControllers.js
@@ -402,12 +402,12 @@ describe('PlaybackController', function () {
                 let onError = function (e) {
                     eventBus.off(Events.PLAYBACK_ERROR, onError);
 
-                    expect(e.error).to.equal('error');
+                    expect(e.error.message).to.equal('error');
                     done();
                 };
 
                 eventBus.on(Events.PLAYBACK_ERROR, onError, this);
-                videoModelMock.fireEvent('error', [{ target: { error: 'error' } }]);
+                videoModelMock.fireEvent('error', [{ target: { error: { code: 3, message: 'error' } } }]);
             });
 
             it('should handle stalled event', function (done) {