rx-player/src/errors/source_buffer_error.ts

Canal+ HTML5 Video Player

/**
 * Error encountered when doing an operation on a `SourceBuffer`.
 * @class SourceBufferError
 * @extends Error
 */
export default class SourceBufferError extends Error {
  public readonly name: "SourceBufferError";
  public readonly errorName: string;
  public readonly isBufferFull: boolean;

  /**
   * @param {string} errorName - The original Error's name.
   * @param {string} message - The original Error's message.
   * @param {boolean} isBufferFull - If `true`, the Error is due to the fact
   * that the `SourceBuffer` was full.
   */
  constructor(errorName: string, message: string, isBufferFull: boolean) {
    super(message);
    // @see https://stackoverflow.com/questions/41102060/typescript-extending-error-class
    Object.setPrototypeOf(this, SourceBufferError.prototype);

    this.name = "SourceBufferError";
    this.errorName = errorName;
    this.isBufferFull = isBufferFull;
  }

  /**
   * If that error has to be communicated through another thread, this method
   * allows to obtain its main defining properties in an Object so the Error can
   * be reconstructed in the other thread.
   * @returns {Object}
   */
  public serialize(): ISerializedSourceBufferError {
    return {
      errorName: this.name,
      message: this.message,
      isBufferFull: this.isBufferFull,
    };
  }

  /**
   * When stringified, just try to replicate the original error as it may be
   * more informative.
   * @returns {string}
   */
  public toString(): string {
    return `${this.errorName}: ${this.message}`;
  }
}

/** Serializable object which allows to create a `SourceBufferError` later. */
export interface ISerializedSourceBufferError {
  /** Identify a `SourceBufferError` */
  errorName: "SourceBufferError";
  /** Indicative message string for the error. */
  message: string;
  /** If `true`, the error is due to the `SourceBuffer` being full. */
  isBufferFull: boolean;
}