xjs-node 2.1.0 → 2.1.1

package/build/func/u-file.d.ts

@@ -12,9 +12,11 @@ export declare namespace UFile {
     function mkdir(p: MaybeArray<string>): boolean;
     function write(p: MaybeArray<string>, c: string): void;
     /**
-     * remove a file. no error if the file to be removed doesn't exist.
+     * remove a file. default is no error if the file to be removed doesn't exist.
+     * @param p path of the file. if passed as an array those are joined.
+     * @param errorIfAbsent raise an error if the file to be removed doesn't exist.
      */
-    function rm(p: MaybeArray<string>): void;
+    function rm(p: MaybeArray<string>, errorIfAbsent?: boolean): void;
     function exists(p: MaybeArray<string>): boolean;
     /**
      * return a file status. if the file of the status doesn't exist, this returns `null`.
@@ -22,6 +24,13 @@ export declare namespace UFile {
     function status(p: MaybeArray<string>): FileStatus;
     function read(p: MaybeArray<string>): Buffer;
     function read(p: MaybeArray<string>, encoding: BufferEncoding): string;
+    /**
+     * read specified file path as a json object.
+     * @param p file path
+     * @param d default value if the file path doesn't exist. default of this is `{}`.
+     * @param encoding encoding used by file reading.
+     */
+    function readAsJson<T>(p: MaybeArray<string>, d?: any, encoding?: BufferEncoding): T;
     function cp(from: MaybeArray<string>, to: MaybeArray<string>): void;
     function mv(from: MaybeArray<string>, to: MaybeArray<string>): void;
     function ls(p: MaybeArray<string>): string[];

package/build/func/u-file.js

@@ -56,12 +56,12 @@ var UFile;
     }
     UFile.write = write;
     /**
-     * remove a file. no error if the file to be removed doesn't exist.
+     * remove a file. default is no error if the file to be removed doesn't exist.
+     * @param p path of the file. if passed as an array those are joined.
+     * @param errorIfAbsent raise an error if the file to be removed doesn't exist.
      */
-    function rm(p) {
-        const pt = (0, u_1.joinPath)(p);
-        if (fs.existsSync(pt))
-            fs.rmSync(pt, { recursive: true });
+    function rm(p, errorIfAbsent) {
+        fs.rmSync((0, u_1.joinPath)(p), { recursive: true, force: !errorIfAbsent });
     }
     UFile.rm = rm;
     function exists(p) {
@@ -83,6 +83,16 @@ var UFile;
         return fs.readFileSync(f, encoding);
     }
     UFile.read = read;
+    /**
+     * read specified file path as a json object.
+     * @param p file path
+     * @param d default value if the file path doesn't exist. default of this is `{}`.
+     * @param encoding encoding used by file reading.
+     */
+    function readAsJson(p, d = {}, encoding = "utf-8") {
+        return UFile.exists(p) ? JSON.parse(UFile.read(p, encoding)) : d;
+    }
+    UFile.readAsJson = readAsJson;
     function cp(from, to) {
         const f = (0, u_1.joinPath)(from), t = (0, u_1.joinPath)(to);
         if (!fs.existsSync(f))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xjs-node",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "library modules for nodejs + typescript that bundled general-purpose implementations.",
   "repository": {
     "type": "git",