pathwatcher - npm Package Compare versions

Comparing version 2.0.9 to 2.0.10

api.json

@@ -6,3 +6,3 @@ {
       "filename": "src/directory.coffee",
-      "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L19",
+      "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L19",
       "sections": [],
@@ -14,21 +14,20 @@ "classMethods": [],
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L29",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L29",
           "visibility": "Public",
           "summary": "Configures a new Directory instance, no files are accessed.",
           "description": "Configures a new Directory instance, no files are accessed.",
-          "arguments": {
-            "description": "",
-            "list": [
-              {
-                "name": "directoryPath",
-                "description": "A {String} containing the absolute path to the directory",
-                "type": "String"
-              },
-              {
-                "name": "symlink",
-                "description": "(optional) A {Boolean} indicating if the path is a symlink, \n```\n                 defaults to false. \n```",
-                "type": "Boolean"
-              }
-            ]
-          }
+          "arguments": [
+            {
+              "name": "directoryPath",
+              "description": "A {String} containing the absolute path to the directory",
+              "type": "String",
+              "isOptional": false
+            },
+            {
+              "name": "symlink",
+              "description": "A {Boolean} indicating if the path is a symlink. (default: false) ",
+              "type": "Boolean",
+              "isOptional": true
+            }
+          ]
         },
@@ -38,3 +37,3 @@ {
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L48",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L48",
           "visibility": "Public",
@@ -53,3 +52,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L55",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L55",
           "visibility": "Public",
@@ -68,3 +67,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L58",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L58",
           "visibility": "Public",
@@ -83,3 +82,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L61",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L61",
           "visibility": "Public",
@@ -98,16 +97,14 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L69",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L69",
           "visibility": "Public",
           "summary": "Traverse within this Directory to a child File. This method doesn't\nactually check to see if the File exists, it just creates the File object.",
           "description": "Traverse within this Directory to a child File. This method doesn't\nactually check to see if the File exists, it just creates the File object.",
-          "arguments": {
-            "description": "",
-            "list": [
-              {
-                "name": "filename",
-                "description": "The {String} name of a File within this Directory.",
-                "type": "String"
-              }
-            ]
-          },
+          "arguments": [
+            {
+              "name": "filename",
+              "description": "The {String} name of a File within this Directory.",
+              "type": "String",
+              "isOptional": false
+            }
+          ],
           "returnValues": [
@@ -123,16 +120,14 @@ {
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L79",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L79",
           "visibility": "Public",
           "summary": "Traverse within this a Directory to a child Directory. This method\ndoesn't actually check to see if the Directory exists, it just creates the\nDirectory object.",
           "description": "Traverse within this a Directory to a child Directory. This method\ndoesn't actually check to see if the Directory exists, it just creates the\nDirectory object.",
-          "arguments": {
-            "description": "",
-            "list": [
-              {
-                "name": "dirname",
-                "description": "The {String} name of the child Directory.",
-                "type": "String"
-              }
-            ]
-          },
+          "arguments": [
+            {
+              "name": "dirname",
+              "description": "The {String} name of the child Directory.",
+              "type": "String",
+              "isOptional": false
+            }
+          ],
           "returnValues": [
@@ -148,3 +143,3 @@ {
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L85",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L85",
           "visibility": "Public",
@@ -163,3 +158,3 @@ "summary": "Traverse to the parent directory.",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L90",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L90",
           "visibility": "Public",
@@ -172,3 +167,3 @@ "summary": "Return a {Boolean}, true if this {Directory} is the root directory\nof the filesystem, or false if it isn't. ",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L97",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L97",
           "visibility": "Public",
@@ -187,3 +182,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L110",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L110",
           "visibility": "Public",
@@ -195,3 +190,3 @@ "summary": "",
               "type": null,
-              "description": "Returns whether the given path (real or symbolic) is inside this directory. This method does not actually check if the path exists, it just checks if the path is under this directory."
+              "description": "Returns whether the given path (real or symbolic) is inside this\ndirectory. This method does not actually check if the path exists, it just\nchecks if the path is under this directory."
             }
@@ -203,3 +198,3 @@ ]
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L135",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L135",
           "visibility": "Public",
@@ -211,3 +206,3 @@ "summary": "",
               "type": "String",
-              "description": "Returns the relative {String} path to the given path from this directory."
+              "description": "Returns the relative {String} path to the given path from this\ndirectory."
             }
@@ -219,3 +214,3 @@ ]
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L170",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L170",
           "visibility": "Public",
@@ -234,37 +229,44 @@ "summary": "Reads file entries in this directory from disk synchronously.",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/directory.coffee#L191",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/directory.coffee#L191",
           "visibility": "Public",
           "summary": "Reads file entries in this directory from disk asynchronously.",
           "description": "Reads file entries in this directory from disk asynchronously.",
-          "arguments": {
-            "description": "",
-            "list": [
-              {
-                "children": [
-                  {
-                    "name": "error",
-                    "description": "An {Error}, may be null.",
-                    "type": "Error"
-                  },
-                  {
-                    "name": "entries",
-                    "description": "An {Array} of {File} and {Directory} objects. ",
-                    "type": "Array"
-                  }
-                ],
-                "name": "callback",
-                "description": "A {Function} to call with the following arguments:",
-                "type": "Function"
-              }
-            ]
-          }
+          "arguments": [
+            {
+              "children": [
+                {
+                  "name": "error",
+                  "description": "An {Error}, may be null.",
+                  "type": "Error",
+                  "isOptional": false
+                },
+                {
+                  "name": "entries",
+                  "description": "An {Array} of {File} and {Directory} objects. ",
+                  "type": "Array",
+                  "isOptional": false
+                }
+              ],
+              "name": "callback",
+              "description": "A {Function} to call with the following arguments:",
+              "type": "Function",
+              "isOptional": false
+            }
+          ]
         }
       ],
+      "classProperties": [],
+      "instanceProperties": [],
       "visibility": "Public",
       "summary": "Represents a directory on disk that can be watched for changes.",
       "description": "Represents a directory on disk that can be watched for changes.",
-      "events": {
-        "description": "### contents-changed\n\nFired when the contents of the directory has changed.",
-        "list": []
-      }
+      "events": [
+        {
+          "name": "contents-changed",
+          "summary": "Fired when the contents of the directory has changed.",
+          "description": "Fired when the contents of the directory has changed.",
+          "visibility": "Public",
+          "arguments": null
+        }
+      ]
     },
@@ -274,3 +276,3 @@ "File": {
       "filename": "src/file.coffee",
-      "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L31",
+      "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L31",
       "sections": [],
@@ -282,6 +284,20 @@ "classMethods": [],
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L40",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L40",
           "visibility": "Public",
           "summary": "Creates a new file.",
-          "description": "Creates a new file.\n\n`filePath` A {String} containing the absolute path to the file\n`symlink` A {Boolean} indicating if the path is a symlink (default: false). "
+          "description": "Creates a new file.",
+          "arguments": [
+            {
+              "name": "filePath",
+              "description": "A {String} containing the absolute path to the file",
+              "type": "String",
+              "isOptional": false
+            },
+            {
+              "name": "symlink",
+              "description": "A {Boolean} indicating if the path is a symlink (default: false). ",
+              "type": "Boolean",
+              "isOptional": false
+            }
+          ]
         },
@@ -291,3 +307,3 @@ {
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L65",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L65",
           "visibility": "Public",
@@ -306,3 +322,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L68",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L68",
           "visibility": "Public",
@@ -321,3 +337,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L75",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L75",
           "visibility": "Public",
@@ -336,3 +352,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L78",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L78",
           "visibility": "Public",
@@ -345,3 +361,3 @@ "summary": "Return the {Directory} that contains this file. ",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L83",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L83",
           "visibility": "Public",
@@ -360,3 +376,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L92",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L92",
           "visibility": "Public",
@@ -369,6 +385,14 @@ "summary": "Return the {String} filename without any directory information. ",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L100",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L100",
           "visibility": "Public",
           "summary": "Overwrites the file with the given text.",
-          "description": "Overwrites the file with the given text.\n\n`text` - The {String} text to write to the underlying file.\n\nReturn undefined. "
+          "description": "Overwrites the file with the given text.",
+          "arguments": [
+            {
+              "name": "text",
+              "description": "The {String} text to write to the underlying file.",
+              "type": "String",
+              "isOptional": false
+            }
+          ]
         },
@@ -378,6 +402,14 @@ {
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L122",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L122",
           "visibility": "Public",
           "summary": "Reads the contents of the file.",
-          "description": "Reads the contents of the file.\n\n`flushCache` A {Boolean} indicating whether to require a direct read or if\n             a cached copy is acceptable.",
+          "description": "Reads the contents of the file.",
+          "arguments": [
+            {
+              "name": "flushCache",
+              "description": "A {Boolean} indicating whether to require a direct read or if a cached copy is acceptable.",
+              "type": "Boolean",
+              "isOptional": false
+            }
+          ],
           "returnValues": [
@@ -393,3 +425,3 @@ {
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L149",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L149",
           "visibility": "Public",
@@ -408,3 +440,3 @@ "summary": "",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.9/src/file.coffee#L158",
+          "srcUrl": "https://github.com/atom/node-pathwatcher/blob/v2.0.10/src/file.coffee#L158",
           "visibility": "Public",
@@ -421,11 +453,32 @@ "summary": "Get the SHA-1 digest of this file",
       ],
+      "classProperties": [],
+      "instanceProperties": [],
       "visibility": "Public",
       "summary": "Represents an individual file that can be watched, read from, and\nwritten to.",
       "description": "Represents an individual file that can be watched, read from, and\nwritten to.",
-      "events": {
-        "description": "### contents-changed\n\nFired when the contents of the file has changed.\n\n### moved\n\nFired when the file has been renamed. {::getPath} will reflect the new path.\n\n### removed\n\nFired when the file has been deleted.",
-        "list": []
-      }
+      "events": [
+        {
+          "name": "contents-changed",
+          "summary": "Fired when the contents of the file has changed.",
+          "description": "Fired when the contents of the file has changed.",
+          "visibility": "Public",
+          "arguments": null
+        },
+        {
+          "name": "moved",
+          "summary": "Fired when the file has been renamed. {::getPath} will reflect the new path.",
+          "description": "Fired when the file has been renamed. {::getPath} will reflect the new path.",
+          "visibility": "Public",
+          "arguments": null
+        },
+        {
+          "name": "removed",
+          "summary": "Fired when the file has been deleted.",
+          "description": "Fired when the file has been deleted.",
+          "visibility": "Public",
+          "arguments": null
+        }
+      ]
     }
   }
 }

package.json

@@ -5,3 +5,3 @@ {
   "description": "Watch files and directories for changes",
-  "version": "2.0.9",
+  "version": "2.0.10",
   "licenses": [
@@ -35,3 +35,3 @@ {
     "temp": "~0.7.0",
-    "grunt-atomdoc": "^0.2.0"
+    "grunt-atomdoc": "^1.0"
   },
@@ -38,0 +38,0 @@ "dependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

66817

increased by2.14%

Lines of code

1069

increased by5.22%

Worsened metrics

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes