Interface AutoResetController

Notifies when playback should be reset and retried.

The controller monitors for retry opportunities after an error is set:

Immediately on network 'online' events
After a timeout interval if online
Immediately on user playback actions (play, pause, seeking, playing)

Each error triggers a single timeout. If another error occurs after a reset, setError() should be called again to schedule the next retry attempt.

interface AutoResetController {
    clear(): void;
    hasAnyListeners(): boolean;
    hasListeners(type: "reset"): boolean;
    on<K extends "reset">(
        type: K,
        handler: EventHandler<AutoResetControllerEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
    setError(error: Error): void;
}

Hierarchy (View Summary)

ReadonlyEventHost<AutoResetControllerEventMap>
Clearable
- AutoResetController

Implemented by

AutoResetControllerImpl

Index

Methods

clear hasAnyListeners hasListeners on setError

Methods

clear

clear(): void
Clears this object.

Returns void
Inherited from Clearable.clear
- Defined in vinyl-util/dist/types/current/core/clearable.d.ts:5

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:30

hasListeners

hasListeners(type: "reset"): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: "reset"
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:34

on

on<K extends "reset">(
    type: K,
    handler: EventHandler<AutoResetControllerEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends "reset"
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<AutoResetControllerEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyEventHost.on
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:26

setError

setError(error: Error): void
Sets the current playback error and begins monitoring for retry opportunities.

Only SERVICE_INTERNAL ReportableErrors are monitored. Subsequent calls while an error is already set are ignored until the error is cleared via reset or clear().

After a reset, if another error occurs, this method should be called again to schedule the next retry attempt.
Parameters
- error: Error
  The error to monitor for retry opportunities
Returns void
- Defined in vinyl/dist/types/current/track/AutoResetController.d.ts:32