@codesandbox/sandpack-client
Version:
<img style="width:100%" src="https://user-images.githubusercontent.com/4838076/143581035-ebee5ba2-9cb1-4fe8-a05b-2f44bd69bb4b.gif" alt="Component toolkit for live running code editing experiences" />
86 lines (85 loc) • 2.87 kB
TypeScript
/// <reference types="node" />
import { BaseFileSystem, FileSystem, BFSCallback, FileSystemOptions } from '../core/file_system';
import { FileFlag } from '../core/file_flag';
import { File } from '../core/file';
import Stats from '../core/node_fs_stats';
/**
* Configuration options for a DynamicHTTPRequest file system.
*/
export interface DynamicHTTPRequestOptions {
index?: string | object;
baseUrl?: string;
preferXHR?: boolean;
}
/**
* A simple filesystem backed by HTTP downloads. You must create a directory listing using the
* `make_http_index` tool provided by BrowserFS.
*
* If you install BrowserFS globally with `npm i -g browserfs`, you can generate a listing by
* running `make_http_index` in your terminal in the directory you would like to index:
*
* ```
* make_http_index > index.json
* ```
*
* Listings objects look like the following:
*
* ```json
* {
* "home": {
* "jvilk": {
* "someFile.txt": null,
* "someDir": {
* // Empty directory
* }
* }
* }
* }
* ```
*
* *This example has the folder `/home/jvilk` with subfile `someFile.txt` and subfolder `someDir`.*
*/
export default class DynamicHTTPRequest extends BaseFileSystem implements FileSystem {
static readonly Name = "DynamicHTTPRequest";
static readonly Options: FileSystemOptions;
/**
* Construct an DynamicHTTPRequest file system backend with the given options.
*/
static Create(opts: DynamicHTTPRequestOptions, cb: BFSCallback<DynamicHTTPRequest>): void;
static isAvailable(): boolean;
readonly prefixUrl: string;
private _requestFileAsyncInternal;
private _requestFileSyncInternal;
private constructor();
private convertAPIError;
empty(): void;
getName(): string;
diskSpace(path: string, cb: (total: number, free: number) => void): void;
isReadOnly(): boolean;
supportsLinks(): boolean;
supportsProps(): boolean;
supportsSynch(): boolean;
stat(path: string, isLstat: boolean, cb: BFSCallback<Stats>): void;
statSync(path: string, isLstat: boolean): Stats;
open(path: string, flags: FileFlag, mode: number, cb: BFSCallback<File>): void;
openSync(path: string, flags: FileFlag, mode: number): File;
readdir(path: string, cb: BFSCallback<string[]>): void;
readdirSync(path: string): string[];
/**
* We have the entire file as a buffer; optimize readFile.
*/
readFile(fname: string, encoding: string, flag: FileFlag, cb: BFSCallback<string | Buffer>): void;
/**
* Specially-optimized readfile.
*/
readFileSync(fname: string, encoding: string, flag: FileFlag): any;
private _getHTTPPath;
/**
* Asynchronously download the given file.
*/
private _requestFileAsync;
/**
* Synchronously download the given file.
*/
private _requestFileSync;
}