Class XmlHttpRequest

src/backend/XmlHttpRequest.ts:65–440

 * *This example has the folder `/home/jvilk` with subfile `someFile.txt` and subfolder `someDir`.*
 */
export default class XmlHttpRequest extends BaseFileSystem implements FileSystem {
  public static readonly Name = "XmlHttpRequest";

  public static readonly Options: FileSystemOptions = {
    index: {
      type: ["string", "object"],
      optional: true,
      description: "URL to a file index as a JSON file or the file index object itself, generated with the make_xhrfs_index script. Defaults to `index.json`."
    },
    baseUrl: {
      type: "string",
      optional: true,
      description: "Used as the URL prefix for fetched files. Default: Fetch files relative to the index."
    }
  };

  /**
   * Construct an XmlHttpRequest file system backend with the given options.
   */
  public static Create(opts: XmlHttpRequestOptions, cb: BFSCallback<XmlHttpRequest>): void {
    if (opts.index === undefined) {
      opts.index = `index.json`;
    }
    if (typeof(opts.index) === "string") {
      XmlHttpRequest.FromURL(opts.index, cb, opts.baseUrl, false);
    } else {
      cb(null, new XmlHttpRequest(opts.index, opts.baseUrl, false));
    }
  }
  public static isAvailable(): boolean {
    return typeof(XMLHttpRequest) !== "undefined" && XMLHttpRequest !== null;
  }
  /**
   * **Deprecated. Please use XmlHttpRequest.Create() method instead to construct XmlHttpRequest objects.**
   *
   * Constructs an XmlHttpRequest object using the directory listing at the given URL.
   * Uses the base URL as the URL prefix for fetched files.
   * @param cb Called when the file system has been instantiated, or if an error occurs.
   */
  public static FromURL(url: string, cb: BFSCallback<XmlHttpRequest>, baseUrl = url.slice(0, url.lastIndexOf('/') + 1), deprecateMsg = true): void {
    if (deprecateMsg) {
      console.warn(`[XmlHttpRequest] XmlHttpRequest.FromURL() is deprecated and will be removed in the next major release. Please use 'XmlHttpRequest.Create({ index: "${url}", baseUrl: "${baseUrl}" }, cb)' instead.`);
    }
    asyncDownloadFile(url, "json", (e, data?) => {
      if (e) {
        cb(e);
      } else {
        cb(null, new XmlHttpRequest(data, baseUrl, false));
      }
    });
  }

  public readonly prefixUrl: string;
  private _index: FileIndex<{}>;
  /**
   * **Deprecated. Please use XmlHttpRequest.Create() method instead to construct XmlHttpRequest objects.**
   *
   * Constructs the file system. You must provide the directory listing as a JSON object