@zenfs/core 1.2.5 → 1.2.7

package/dist/config.d.ts

@@ -61,6 +61,15 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
      * @default false
      */
     disableUpdateOnRead: boolean;
+    /**
+     * If true, files will only sync to the file system when closed.
+     *
+     * This can increase performance.
+     * @experimental
+     * @overrides `disableUpdateOnRead`
+     * @default false
+     */
+    onlySyncOnClose: boolean;
 }
 /**
  * Configures ZenFS with single mount point /

package/dist/config.js

@@ -71,6 +71,7 @@ export async function configure(configuration) {
     cache.setEnabled(configuration.cacheStats ?? false);
     config.checkAccess = !configuration.disableAccessChecks;
     config.updateOnRead = !configuration.disableUpdateOnRead;
+    config.syncImmediately = !configuration.onlySyncOnClose;
     if (configuration.addDevices) {
         const devfs = new DeviceFS();
         devfs.createDevice('/null', nullDevice);

package/dist/emulation/config.d.ts

@@ -4,9 +4,13 @@ export declare const config: {
      */
     checkAccess: boolean;
     /**
-     * Whether to sync atime updates immediately when reading from a file
+     * Whether to mark a file as dirty after updating its `atime` when read from
      */
     updateOnRead: boolean;
+    /**
+     * Whether to immediately sync when files are changed
+     */
+    syncImmediately: boolean;
     /**
      * If a file's buffer is not large enough to store content when writing and the buffer can't be resized, reuse the buffer passed to write()
      */

package/dist/emulation/config.js

@@ -4,9 +4,13 @@ export const config = {
      */
     checkAccess: true,
     /**
-     * Whether to sync atime updates immediately when reading from a file
+     * Whether to mark a file as dirty after updating its `atime` when read from
      */
     updateOnRead: true,
+    /**
+     * Whether to immediately sync when files are changed
+     */
+    syncImmediately: true,
     /**
      * If a file's buffer is not large enough to store content when writing and the buffer can't be resized, reuse the buffer passed to write()
      */

package/dist/file.js

@@ -289,11 +289,13 @@ export class PreloadFile extends File {
     }
     async truncate(length) {
         this._truncate(length);
-        await this.sync();
+        if (config.syncImmediately)
+            await this.sync();
     }
     truncateSync(length) {
         this._truncate(length);
-        this.syncSync();
+        if (config.syncImmediately)
+            this.syncSync();
     }
     _write(buffer, offset = 0, length = this.stats.size, position = this.position) {
         if (this.closed) {
@@ -337,7 +339,8 @@ export class PreloadFile extends File {
      */
     async write(buffer, offset, length, position) {
         const bytesWritten = this._write(buffer, offset, length, position);
-        await this.sync();
+        if (config.syncImmediately)
+            await this.sync();
         return bytesWritten;
     }
     /**
@@ -351,7 +354,8 @@ export class PreloadFile extends File {
      */
     writeSync(buffer, offset = 0, length = this.stats.size, position = this.position) {
         const bytesWritten = this._write(buffer, offset, length, position);
-        this.syncSync();
+        if (config.syncImmediately)
+            this.syncSync();
         return bytesWritten;
     }
     _read(buffer, offset = 0, length = this.stats.size, position) {
@@ -363,8 +367,8 @@ export class PreloadFile extends File {
         }
         if (config.updateOnRead) {
             this.dirty = true;
-            this.stats.atimeMs = Date.now();
         }
+        this.stats.atimeMs = Date.now();
         position ?? (position = this.position);
         let end = position + length;
         if (end > this.stats.size) {
@@ -389,7 +393,8 @@ export class PreloadFile extends File {
      */
     async read(buffer, offset, length, position) {
         const bytesRead = this._read(buffer, offset, length, position);
-        await this.sync();
+        if (config.syncImmediately)
+            await this.sync();
         return { bytesRead, buffer };
     }
     /**
@@ -403,7 +408,8 @@ export class PreloadFile extends File {
      */
     readSync(buffer, offset, length, position) {
         const bytesRead = this._read(buffer, offset, length, position);
-        this.syncSync();
+        if (config.syncImmediately)
+            this.syncSync();
         return bytesRead;
     }
     async chmod(mode) {
@@ -412,7 +418,8 @@ export class PreloadFile extends File {
         }
         this.dirty = true;
         this.stats.chmod(mode);
-        await this.sync();
+        if (config.syncImmediately)
+            await this.sync();
     }
     chmodSync(mode) {
         if (this.closed) {
@@ -420,7 +427,8 @@ export class PreloadFile extends File {
         }
         this.dirty = true;
         this.stats.chmod(mode);
-        this.syncSync();
+        if (config.syncImmediately)
+            this.syncSync();
     }
     async chown(uid, gid) {
         if (this.closed) {
@@ -428,7 +436,8 @@ export class PreloadFile extends File {
         }
         this.dirty = true;
         this.stats.chown(uid, gid);
-        await this.sync();
+        if (config.syncImmediately)
+            await this.sync();
     }
     chownSync(uid, gid) {
         if (this.closed) {
@@ -436,7 +445,8 @@ export class PreloadFile extends File {
         }
         this.dirty = true;
         this.stats.chown(uid, gid);
-        this.syncSync();
+        if (config.syncImmediately)
+            this.syncSync();
     }
     async utimes(atime, mtime) {
         if (this.closed) {
@@ -445,7 +455,8 @@ export class PreloadFile extends File {
         this.dirty = true;
         this.stats.atime = atime;
         this.stats.mtime = mtime;
-        await this.sync();
+        if (config.syncImmediately)
+            await this.sync();
     }
     utimesSync(atime, mtime) {
         if (this.closed) {
@@ -454,7 +465,8 @@ export class PreloadFile extends File {
         this.dirty = true;
         this.stats.atime = atime;
         this.stats.mtime = mtime;
-        this.syncSync();
+        if (config.syncImmediately)
+            this.syncSync();
     }
     async _setType(type) {
         if (this.closed) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "1.2.5",
+	"version": "1.2.7",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",

package/src/config.ts

@@ -126,6 +126,16 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
 	 * @default false
 	 */
 	disableUpdateOnRead: boolean;
+
+	/**
+	 * If true, files will only sync to the file system when closed.
+	 *
+	 * This can increase performance.
+	 * @experimental
+	 * @overrides `disableUpdateOnRead`
+	 * @default false
+	 */
+	onlySyncOnClose: boolean;
 }
 
 /**
@@ -154,6 +164,7 @@ export async function configure<T extends ConfigMounts>(configuration: Partial<C
 	cache.setEnabled(configuration.cacheStats ?? false);
 	config.checkAccess = !configuration.disableAccessChecks;
 	config.updateOnRead = !configuration.disableUpdateOnRead;
+	config.syncImmediately = !configuration.onlySyncOnClose;
 
 	if (configuration.addDevices) {
 		const devfs = new DeviceFS();

package/src/emulation/config.ts

@@ -5,10 +5,15 @@ export const config = {
 	checkAccess: true,
 
 	/**
-	 * Whether to sync atime updates immediately when reading from a file
+	 * Whether to mark a file as dirty after updating its `atime` when read from
 	 */
 	updateOnRead: true,
 
+	/**
+	 * Whether to immediately sync when files are changed
+	 */
+	syncImmediately: true,
+
 	/**
 	 * If a file's buffer is not large enough to store content when writing and the buffer can't be resized, reuse the buffer passed to write()
 	 */

package/src/file.ts

@@ -441,12 +441,12 @@ export class PreloadFile<FS extends FileSystem> extends File {
 
 	public async truncate(length: number): Promise<void> {
 		this._truncate(length);
-		await this.sync();
+		if (config.syncImmediately) await this.sync();
 	}
 
 	public truncateSync(length: number): void {
 		this._truncate(length);
-		this.syncSync();
+		if (config.syncImmediately) this.syncSync();
 	}
 
 	protected _write(buffer: Uint8Array, offset: number = 0, length: number = this.stats.size, position: number = this.position): number {
@@ -494,7 +494,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 	 */
 	public async write(buffer: Uint8Array, offset?: number, length?: number, position?: number): Promise<number> {
 		const bytesWritten = this._write(buffer, offset, length, position);
-		await this.sync();
+		if (config.syncImmediately) await this.sync();
 		return bytesWritten;
 	}
 
@@ -509,7 +509,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 	 */
 	public writeSync(buffer: Uint8Array, offset: number = 0, length: number = this.stats.size, position: number = this.position): number {
 		const bytesWritten = this._write(buffer, offset, length, position);
-		this.syncSync();
+		if (config.syncImmediately) this.syncSync();
 		return bytesWritten;
 	}
 
@@ -517,13 +517,17 @@ export class PreloadFile<FS extends FileSystem> extends File {
 		if (this.closed) {
 			throw ErrnoError.With('EBADF', this.path, 'File.read');
 		}
+
 		if (!isReadable(this.flag)) {
 			throw new ErrnoError(Errno.EPERM, 'File not opened with a readable mode.');
 		}
+
 		if (config.updateOnRead) {
 			this.dirty = true;
-			this.stats.atimeMs = Date.now();
 		}
+
+		this.stats.atimeMs = Date.now();
+
 		position ??= this.position;
 		let end = position + length;
 		if (end > this.stats.size) {
@@ -549,7 +553,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 	 */
 	public async read<TBuffer extends ArrayBufferView>(buffer: TBuffer, offset?: number, length?: number, position?: number): Promise<{ bytesRead: number; buffer: TBuffer }> {
 		const bytesRead = this._read(buffer, offset, length, position);
-		await this.sync();
+		if (config.syncImmediately) await this.sync();
 		return { bytesRead, buffer };
 	}
 
@@ -564,7 +568,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 	 */
 	public readSync(buffer: ArrayBufferView, offset?: number, length?: number, position?: number): number {
 		const bytesRead = this._read(buffer, offset, length, position);
-		this.syncSync();
+		if (config.syncImmediately) this.syncSync();
 		return bytesRead;
 	}
 
@@ -574,7 +578,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 		}
 		this.dirty = true;
 		this.stats.chmod(mode);
-		await this.sync();
+		if (config.syncImmediately) await this.sync();
 	}
 
 	public chmodSync(mode: number): void {
@@ -583,7 +587,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 		}
 		this.dirty = true;
 		this.stats.chmod(mode);
-		this.syncSync();
+		if (config.syncImmediately) this.syncSync();
 	}
 
 	public async chown(uid: number, gid: number): Promise<void> {
@@ -592,7 +596,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 		}
 		this.dirty = true;
 		this.stats.chown(uid, gid);
-		await this.sync();
+		if (config.syncImmediately) await this.sync();
 	}
 
 	public chownSync(uid: number, gid: number): void {
@@ -601,7 +605,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 		}
 		this.dirty = true;
 		this.stats.chown(uid, gid);
-		this.syncSync();
+		if (config.syncImmediately) this.syncSync();
 	}
 
 	public async utimes(atime: Date, mtime: Date): Promise<void> {
@@ -611,7 +615,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 		this.dirty = true;
 		this.stats.atime = atime;
 		this.stats.mtime = mtime;
-		await this.sync();
+		if (config.syncImmediately) await this.sync();
 	}
 
 	public utimesSync(atime: Date, mtime: Date): void {
@@ -621,7 +625,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 		this.dirty = true;
 		this.stats.atime = atime;
 		this.stats.mtime = mtime;
-		this.syncSync();
+		if (config.syncImmediately) this.syncSync();
 	}
 
 	public async _setType(type: FileType): Promise<void> {