@zenfs/core 0.0.12 → 0.2.0

package/dist/backends/OverlayFS.d.ts

@@ -1,9 +1,9 @@
-import { type FileSystem, BaseFileSystem, FileSystemMetadata } from '../filesystem.js';
-import { File, FileFlag, PreloadFile } from '../file.js';
+import { FileSystem, FileSystemMetadata } from '../filesystem.js';
+import { File, FileFlag } from '../file.js';
 import { Stats } from '../stats.js';
 import LockedFS from './Locked.js';
 import { Cred } from '../cred.js';
-import { type BackendOptions } from './backend.js';
+import type { Backend } from './backend.js';
 export declare namespace OverlayFS {
     /**
      * Configuration options for OverlayFS instances.
@@ -20,13 +20,15 @@ export declare namespace OverlayFS {
     }
 }
 /**
- * *INTERNAL, DO NOT USE DIRECTLY!*
+ * OverlayFS makes a read-only filesystem writable by storing writes on a second, writable file system.
+ * Deletes are persisted via metadata stored on the writable file system.
  *
- * Core OverlayFS class that contains no locking whatsoever. We wrap these objects
- * in a LockedFS to prevent races.
+ * This class contains no locking whatsoever. It is wrapped in a LockedFS to prevent races.
+ *
+ * @internal
  */
-export declare class UnlockedOverlayFS extends BaseFileSystem {
-    static isAvailable(): boolean;
+export declare class UnlockedOverlayFS extends FileSystem {
+    ready(): Promise<this>;
     private _writable;
     private _readable;
     private _isInitialized;
@@ -34,19 +36,16 @@ export declare class UnlockedOverlayFS extends BaseFileSystem {
     private _deleteLog;
     private _deleteLogUpdatePending;
     private _deleteLogUpdateNeeded;
-    private _deleteLogError;
+    private _deleteLogError?;
+    private _ready;
     constructor({ writable, readable }: OverlayFS.Options);
     get metadata(): FileSystemMetadata;
-    getOverlayedFileSystems(): {
-        readable: FileSystem;
-        writable: FileSystem;
-    };
-    _syncAsync(file: PreloadFile<UnlockedOverlayFS>): Promise<void>;
-    _syncSync(file: PreloadFile<UnlockedOverlayFS>): void;
+    getOverlayedFileSystems(): OverlayFS.Options;
+    sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
+    syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
     /**
-     * **INTERNAL METHOD**
-     *
      * Called once to load up metadata stored on the writable file system.
+     * @internal
      */
     _initialize(): Promise<void>;
     getDeletionLog(): string;
@@ -55,8 +54,12 @@ export declare class UnlockedOverlayFS extends BaseFileSystem {
     renameSync(oldPath: string, newPath: string, cred: Cred): void;
     stat(p: string, cred: Cred): Promise<Stats>;
     statSync(p: string, cred: Cred): Stats;
-    open(p: string, flag: FileFlag, mode: number, cred: Cred): Promise<File>;
-    openSync(p: string, flag: FileFlag, mode: number, cred: Cred): File;
+    openFile(path: string, flag: FileFlag, cred: Cred): Promise<File>;
+    openFileSync(path: string, flag: FileFlag, cred: Cred): File;
+    createFile(path: string, flag: FileFlag, mode: number, cred: Cred): Promise<File>;
+    createFileSync(path: string, flag: FileFlag, mode: number, cred: Cred): File;
+    link(srcpath: string, dstpath: string, cred: Cred): Promise<void>;
+    linkSync(srcpath: string, dstpath: string, cred: Cred): void;
     unlink(p: string, cred: Cred): Promise<void>;
     unlinkSync(p: string, cred: Cred): void;
     rmdir(p: string, cred: Cred): Promise<void>;
@@ -65,14 +68,6 @@ export declare class UnlockedOverlayFS extends BaseFileSystem {
     mkdirSync(p: string, mode: number, cred: Cred): void;
     readdir(p: string, cred: Cred): Promise<string[]>;
     readdirSync(p: string, cred: Cred): string[];
-    exists(p: string, cred: Cred): Promise<boolean>;
-    existsSync(p: string, cred: Cred): boolean;
-    chmod(p: string, mode: number, cred: Cred): Promise<void>;
-    chmodSync(p: string, mode: number, cred: Cred): void;
-    chown(p: string, new_uid: number, new_gid: number, cred: Cred): Promise<void>;
-    chownSync(p: string, new_uid: number, new_gid: number, cred: Cred): void;
-    utimes(p: string, atime: Date, mtime: Date, cred: Cred): Promise<void>;
-    utimesSync(p: string, atime: Date, mtime: Date, cred: Cred): void;
     private deletePath;
     private updateLog;
     private _reparseDeletionLog;
@@ -82,8 +77,8 @@ export declare class UnlockedOverlayFS extends BaseFileSystem {
      * With the given path, create the needed parent directories on the writable storage
      * should they not exist. Use modes from the read-only storage.
      */
+    private createParentDirectoriesSync;
     private createParentDirectories;
-    private createParentDirectoriesAsync;
     /**
      * Helper function:
      * - Ensures p is on writable before proceeding. Throws an error if it doesn't exist.
@@ -95,8 +90,8 @@ export declare class UnlockedOverlayFS extends BaseFileSystem {
      * Copy from readable to writable storage.
      * PRECONDITION: File does not exist on writable storage.
      */
+    private copyToWritableSync;
     private copyToWritable;
-    private copyToWritableAsync;
 }
 /**
  * OverlayFS makes a read-only filesystem writable by storing writes on a second,
@@ -104,10 +99,7 @@ export declare class UnlockedOverlayFS extends BaseFileSystem {
  * file system.
  */
 export declare class OverlayFS extends LockedFS<UnlockedOverlayFS> {
-    static readonly Name = "OverlayFS";
-    static Create: any;
-    static readonly Options: BackendOptions;
-    static isAvailable(): boolean;
+    ready(): Promise<this>;
     /**
      * @param options The options to initialize the OverlayFS with
      */
@@ -116,5 +108,5 @@ export declare class OverlayFS extends LockedFS<UnlockedOverlayFS> {
     getDeletionLog(): string;
     resDeletionLog(): string;
     unwrap(): UnlockedOverlayFS;
-    private _initialize;
 }
+export declare const Overlay: Backend;