vscode-fs 0.0.7 → 0.0.9

package/dist/index.cjs

@@ -26,6 +26,16 @@ let FileType = /* @__PURE__ */ function(FileType) {
 	FileType[FileType["SymbolicLink"] = 64] = "SymbolicLink";
 	return FileType;
 }({});
+/**
+* The flags to use for the file.
+*/
+let WriteableFlags = /* @__PURE__ */ function(WriteableFlags) {
+	/**
+	* Append to the file.
+	*/
+	WriteableFlags["Append"] = "a";
+	return WriteableFlags;
+}({});
 let FileSystemError;
 (function(_FileSystemError) {
 	function isFileSystemError(error) {
@@ -339,9 +349,17 @@ async function createNodeFileSystem() {
 				});
 			});
 		},
-		createWritableStream: async (uri) => {
-			const writableStream = fs.createWriteStream(uri.fsPath);
+		createWritableStream: async (uri, options) => {
+			const writableStream = fs.createWriteStream(uri.fsPath, {
+				...options,
+				encoding: options?.encoding,
+				flags: options?.flags
+			});
 			return stream.Writable.toWeb(writableStream);
+		},
+		createReadableStream: async (uri) => {
+			const readableStream = fs.createReadStream(uri.fsPath);
+			return stream.Readable.toWeb(readableStream);
 		}
 	};
 }
@@ -392,6 +410,7 @@ Object.defineProperty(exports, 'FileSystemError', {
 exports.FileSystemProviderErrorCode = FileSystemProviderErrorCode;
 exports.FileType = FileType;
 exports.RelativePattern = RelativePattern;
+exports.WriteableFlags = WriteableFlags;
 exports.createFileSystemError = createFileSystemError;
 exports.createNodeFileSystem = createNodeFileSystem;
 exports.toFileSystemError = toFileSystemError;

package/dist/index.d.cts

@@ -238,7 +238,36 @@ interface FileSystem {
    * @param uri The uri of the file to write to.
    * @returns A writer for the file.
    */
-  createWritableStream(uri: URI): Promise<WritableStream<Uint8Array>>;
+  createWritableStream(uri: URI, options?: {
+    /**
+     * The encoding to use for the file.
+     */
+    readonly encoding?: NodeJS.BufferEncoding | (string & {});
+    /**
+     * The flag to use for the file.
+     */
+    readonly flags?: WriteableFlags | (string & {});
+    /**
+     * Additional options.
+     */
+    readonly [key: string]: unknown;
+  }): Promise<WritableStream<Uint8Array>>;
+  /**
+   * Create a readable stream for a file.
+   *
+   * @param uri The uri of the file to read from.
+   * @returns A readable stream for the file.
+   */
+  createReadableStream(uri: URI): Promise<ReadableStream<Uint8Array>>;
+}
+/**
+ * The flags to use for the file.
+ */
+declare enum WriteableFlags {
+  /**
+   * Append to the file.
+   */
+  Append = "a"
 }
 interface Disposable {
   /** Dispose resources. */
@@ -408,4 +437,4 @@ declare function toFileSystemError(error: NodeJS.ErrnoException): FileSystemErro
 //#region src/node.d.ts
 declare function createNodeFileSystem(): Promise<FileSystem>;
 //#endregion
-export { Disposable, FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileSystemWatcher, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { Disposable, FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileSystemWatcher, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, WriteableFlags, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/dist/index.d.mts

@@ -238,7 +238,36 @@ interface FileSystem {
    * @param uri The uri of the file to write to.
    * @returns A writer for the file.
    */
-  createWritableStream(uri: URI): Promise<WritableStream<Uint8Array>>;
+  createWritableStream(uri: URI, options?: {
+    /**
+     * The encoding to use for the file.
+     */
+    readonly encoding?: NodeJS.BufferEncoding | (string & {});
+    /**
+     * The flag to use for the file.
+     */
+    readonly flags?: WriteableFlags | (string & {});
+    /**
+     * Additional options.
+     */
+    readonly [key: string]: unknown;
+  }): Promise<WritableStream<Uint8Array>>;
+  /**
+   * Create a readable stream for a file.
+   *
+   * @param uri The uri of the file to read from.
+   * @returns A readable stream for the file.
+   */
+  createReadableStream(uri: URI): Promise<ReadableStream<Uint8Array>>;
+}
+/**
+ * The flags to use for the file.
+ */
+declare enum WriteableFlags {
+  /**
+   * Append to the file.
+   */
+  Append = "a"
 }
 interface Disposable {
   /** Dispose resources. */
@@ -408,4 +437,4 @@ declare function toFileSystemError(error: NodeJS.ErrnoException): FileSystemErro
 //#region src/node.d.ts
 declare function createNodeFileSystem(): Promise<FileSystem>;
 //#endregion
-export { Disposable, FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileSystemWatcher, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { Disposable, FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileSystemWatcher, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, WriteableFlags, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/dist/index.mjs

@@ -25,6 +25,16 @@ let FileType = /* @__PURE__ */ function(FileType) {
 	FileType[FileType["SymbolicLink"] = 64] = "SymbolicLink";
 	return FileType;
 }({});
+/**
+* The flags to use for the file.
+*/
+let WriteableFlags = /* @__PURE__ */ function(WriteableFlags) {
+	/**
+	* Append to the file.
+	*/
+	WriteableFlags["Append"] = "a";
+	return WriteableFlags;
+}({});
 let FileSystemError;
 (function(_FileSystemError) {
 	function isFileSystemError(error) {
@@ -338,9 +348,17 @@ async function createNodeFileSystem() {
 				});
 			});
 		},
-		createWritableStream: async (uri) => {
-			const writableStream = fs.createWriteStream(uri.fsPath);
+		createWritableStream: async (uri, options) => {
+			const writableStream = fs.createWriteStream(uri.fsPath, {
+				...options,
+				encoding: options?.encoding,
+				flags: options?.flags
+			});
 			return stream.Writable.toWeb(writableStream);
+		},
+		createReadableStream: async (uri) => {
+			const readableStream = fs.createReadStream(uri.fsPath);
+			return stream.Readable.toWeb(readableStream);
 		}
 	};
 }
@@ -382,4 +400,4 @@ var NodeFileSystemWatcherImpl = class {
 };
 
 //#endregion
-export { FileSystemError, FileSystemProviderErrorCode, FileType, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { FileSystemError, FileSystemProviderErrorCode, FileType, RelativePattern, WriteableFlags, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vscode-fs",
   "type": "module",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "VSCode like simple、serializable and cross-platform file system utilities.",
   "author": "Naily Zero <zero@naily.cc> (https://naily.cc)",
   "license": "MIT",