[generated] sandpack files from: codesandbox-client

sandpack-generated/static/browserfs11/node/backend/WorkerFS.d.ts

@@ -0,0 +1,92 @@
+import { BaseFileSystem, FileSystem, BFSOneArgCallback, BFSCallback, FileSystemOptions } from '../core/file_system';
+import { FileFlag } from '../core/file_flag';
+import { File } from '../core/file';
+import { default as Stats } from '../core/node_fs_stats';
+export interface WorkerFSOptions {
+    worker: Worker;
+}
+/**
+ * WorkerFS lets you access a BrowserFS instance that is running in a different
+ * JavaScript context (e.g. access BrowserFS in one of your WebWorkers, or
+ * access BrowserFS running on the main page from a WebWorker).
+ *
+ * For example, to have a WebWorker access files in the main browser thread,
+ * do the following:
+ *
+ * MAIN BROWSER THREAD:
+ *
+ * ```javascript
+ *   // Listen for remote file system requests.
+ *   BrowserFS.FileSystem.WorkerFS.attachRemoteListener(webWorkerObject);
+ * ```
+ *
+ * WEBWORKER THREAD:
+ *
+ * ```javascript
+ *   // Set the remote file system as the root file system.
+ *   BrowserFS.configure({ fs: "WorkerFS", options: { worker: self }}, function(e) {
+ *     // Ready!
+ *   });
+ * ```
+ *
+ * Note that synchronous operations are not permitted on the WorkerFS, regardless
+ * of the configuration option of the remote FS.
+ */
+export default class WorkerFS extends BaseFileSystem implements FileSystem {
+    static readonly Name = "WorkerFS";
+    static readonly Options: FileSystemOptions;
+    static Create(opts: WorkerFSOptions, cb: BFSCallback<WorkerFS>): void;
+    static isAvailable(): boolean;
+    /**
+     * Attaches a listener to the remote worker for file system requests.
+     */
+    static attachRemoteListener(worker: Worker): void;
+    private _worker;
+    private _callbackConverter;
+    private _isInitialized;
+    private _isReadOnly;
+    private _supportLinks;
+    private _supportProps;
+    /**
+     * Constructs a new WorkerFS instance that connects with BrowserFS running on
+     * the specified worker.
+     */
+    private constructor();
+    getName(): string;
+    isReadOnly(): boolean;
+    supportsSynch(): boolean;
+    supportsLinks(): boolean;
+    supportsProps(): boolean;
+    rename(oldPath: string, newPath: string, cb: BFSOneArgCallback): void;
+    stat(p: string, isLstat: boolean, cb: BFSCallback<Stats>): void;
+    open(p: string, flag: FileFlag, mode: number, cb: BFSCallback<File>): void;
+    unlink(p: string, cb: Function): void;
+    rmdir(p: string, cb: Function): void;
+    mkdir(p: string, mode: number, cb: Function): void;
+    readdir(p: string, cb: BFSCallback<string[]>): void;
+    exists(p: string, cb: (exists: boolean) => void): void;
+    realpath(p: string, cache: {
+        [path: string]: string;
+    }, cb: BFSCallback<string>): void;
+    truncate(p: string, len: number, cb: Function): void;
+    readFile(fname: string, encoding: string, flag: FileFlag, cb: BFSCallback<any>): void;
+    writeFile(fname: string, data: any, encoding: string, flag: FileFlag, mode: number, cb: BFSOneArgCallback): void;
+    appendFile(fname: string, data: any, encoding: string, flag: FileFlag, mode: number, cb: BFSOneArgCallback): void;
+    chmod(p: string, isLchmod: boolean, mode: number, cb: Function): void;
+    chown(p: string, isLchown: boolean, uid: number, gid: number, cb: Function): void;
+    utimes(p: string, atime: Date, mtime: Date, cb: Function): void;
+    link(srcpath: string, dstpath: string, cb: Function): void;
+    symlink(srcpath: string, dstpath: string, type: string, cb: Function): void;
+    readlink(p: string, cb: Function): void;
+    syncClose(method: string, fd: File, cb: BFSOneArgCallback): void;
+    /**
+     * Called once both local and remote sides are set up.
+     */
+    private _initialize;
+    private _argRemote2Local;
+    private _rpc;
+    /**
+     * Converts a local argument into a remote argument. Public so WorkerFile objects can call it.
+     */
+    private _argLocal2Remote;
+}