check-disk-space 2.0.0 → 2.1.0

package/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [Alex-D]
+patreon: AlexandreDemode

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "check-disk-space",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Light multi-platform disk space checker without third party for Node.js",
   "main": "index.js",
-  "engines" : {
-    "node" : ">=8"
+  "engines": {
+    "node": ">=8"
   },
   "dependencies": {},
   "devDependencies": {
@@ -33,6 +33,7 @@
     "hdd",
     "free"
   ],
+  "types": "./typings/index.d.ts",
   "author": "Alex-D <contact@alex-d.fr> (http://alex-d.fr)",
   "license": "MIT",
   "bugs": {

package/typings/index.d.ts

@@ -0,0 +1,77 @@
+declare module "check-disk-space" {
+  namespace checkDiskSpace {
+    /**
+     * The result of the disk space check
+     */
+    interface CheckDiskSpaceResult {
+      /**
+       * How much space is left
+       */
+      free: number;
+      /**
+       * The size of the path
+       */
+      size: number;
+    }
+
+    /**
+     * Error for invalid path
+     */
+    class InvalidPathError {
+      constructor(message: string);
+      /**
+       * The name of the error
+       */
+      name: "InvalidPathError";
+      /**
+       * The error message
+       */
+      message: string | "";
+    }
+
+    /**
+     * Error for path which do not match the actual file system
+     */
+    class NoMatchError {
+      constructor(message: any);
+      /**
+       * The name of the error
+       */
+      name: "NoMatchError";
+      /**
+       * The error message
+       */
+      message: string | "";
+    }
+
+    /**
+     * Get the first existing parent path
+     *
+     * @param {string} directoryPath The file/folder path from where we want to know disk space
+     * @returns {string} The first existing parent path
+     */
+    function getFirstExistingParentPath(directoryPath: string): string;
+  }
+
+  /**
+   * Build the check call for unix or win32
+   *
+   * @param {string} directoryPath The file/folder path from where we want to know disk space
+   * @return {Promise<CheckDiskSpaceResult>} The result of the check
+   *
+   * @example
+   * // On Windows
+   * const diskSpace = await checkDiskSpace('C:/blabla/bla');
+   * console.log(diskSpace); // { free: 12345678, size: 98756432 }
+   *
+   * @example
+   * const diskSpace = await checkDiskSpace('/mnt/mygames');
+   * console.log(diskSpace); // { free: 12345678, size: 98756432 }
+   *
+   * @throws {NoMatchError} In case the given path does not match with the actual file system
+   * @throws {InvalidPathError} In case the path is invalid
+   */
+  function checkDiskSpace(directoryPath: string): Promise<checkDiskSpace.CheckDiskSpaceResult>;
+
+  export = checkDiskSpace;
+}

package/typings/index.test.ts

@@ -0,0 +1,19 @@
+import * as checkDiskSpace from 'check-disk-space';
+
+(async () => {
+  try {
+    const diskSpace = await checkDiskSpace('/mnt/mygames');
+    diskSpace.free;
+    diskSpace.size;
+  } catch (err) {
+    if (err instanceof checkDiskSpace.InvalidPathError) {
+      console.error('Invalid Path Error');
+    } else if (err instanceof checkDiskSpace.NoMatchError) {
+      console.error('No Match Error');
+    } else {
+      console.error('Error');
+    }
+  }
+})();
+
+checkDiskSpace.getFirstExistingParentPath('/path');