Class HTML5FS

src/backend/HTML5FS.ts:158–532

 * only available in Chrome.
 */
export default class HTML5FS extends BaseFileSystem implements IFileSystem {
  public static readonly Name = "HTML5FS";

  public static readonly Options: FileSystemOptions = {
    size: {
      type: "number",
      optional: true,
      description: "Storage quota to request, in megabytes. Allocated value may be less. Defaults to 5."
    },
    type: {
      type: "number",
      optional: true,
      description: "window.PERSISTENT or window.TEMPORARY. Defaults to PERSISTENT."
    }
  };

  /**
   * Creates an HTML5FS instance with the given options.
   */
  public static Create(opts: HTML5FSOptions, cb: BFSCallback<HTML5FS>): void {
    const fs = new HTML5FS(opts.size, opts.type, false);
    fs.allocate((e) => e ? cb(e) : cb(null, fs), false);
  }
  public static isAvailable(): boolean {
    return !!_getFS;
  }

  // HTML5File reaches into HTML5FS. :/
  public fs: FileSystem;
  private size: number;
  private type: number;
  /**
   * **Deprecated. Please use HTML5FS.Create() method instead.**
   *
   * Creates a new HTML5 FileSystem-backed BrowserFS file system of the given size
   * and storage type.
   *
   * **IMPORTANT**: You must call `allocate` on the resulting object before the file system
   * can be used.
   *
   * @param size storage quota to request, in megabytes. Allocated value may be less.
   * @param type window.PERSISTENT or window.TEMPORARY. Defaults to PERSISTENT.
   */
  constructor(size: number = 5, type: number = global.PERSISTENT, deprecateMsg = true) {
    super();
    // Convert MB to bytes.
    this.size = 1024 * 1024 * size;
    this.type = type;
    deprecationMessage(deprecateMsg, HTML5FS.Name, {size: size, type: type});
  }

  public getName(): string {
    return HTML5FS.Name;
  }

  public isReadOnly(): boolean {
    return false;
  }