space-pen - npm Package Compare versions

Comparing version 3.4.2 to 3.4.3

api.json

@@ -7,3 +7,3 @@ {
       "filename": "src/space-pen.coffee",
-      "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.2/src/space-pen.coffee#L59",
+      "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.3/src/space-pen.coffee#L60",
       "sections": [],
@@ -14,3 +14,3 @@ "classMethods": [
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.2/src/space-pen.coffee#L66",
+          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.3/src/space-pen.coffee#L67",
           "visibility": "Public",
@@ -23,3 +23,3 @@ "summary": "Add the given subview wired to an outlet with the given name ",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.2/src/space-pen.coffee#L70",
+          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.3/src/space-pen.coffee#L71",
           "visibility": "Public",
@@ -32,3 +32,3 @@ "summary": "Add a text node with the given text content ",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.2/src/space-pen.coffee#L73",
+          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.3/src/space-pen.coffee#L74",
           "visibility": "Public",
@@ -41,3 +41,3 @@ "summary": "Add a new tag with the given name ",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.2/src/space-pen.coffee#L76",
+          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.3/src/space-pen.coffee#L77",
           "visibility": "Public",
@@ -52,6 +52,31 @@ "summary": "Add new child DOM nodes from the given raw HTML string. ",
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.2/src/space-pen.coffee#L168",
+          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.3/src/space-pen.coffee#L169",
           "visibility": "Public",
           "summary": "Calls the given handler when commandName is triggered on the {View}.",
-          "description": "Calls the given handler when commandName is triggered on the {View}.\n\nThis is enhanced version of jQuery's `::on` method. It listens for a custom\nDOM event and adds metadata to the DOM to maintain a list of all commands.\n\ncommandName - A namespaced {String} describing the command, such as\n              `find-and-replace:toggle`.\nselector - An optional selector {String} to filter the descendants of the\n           elements that trigger the event.\noptions - An optional options {Object} with an `data` key.\nhandler - A {Function} to execute when the command is triggered. "
+          "description": "Calls the given handler when commandName is triggered on the {View}.\n\nThis is enhanced version of jQuery's `::on` method. It listens for a custom\nDOM event and adds metadata to the DOM to maintain a list of all commands.",
+          "arguments": {
+            "description": "",
+            "list": [
+              {
+                "name": "commandName",
+                "description": "A namespaced {String} describing the command, such as \n```\n          `find-and-replace:toggle`.\n```",
+                "type": "String"
+              },
+              {
+                "name": "selector",
+                "description": "An optional selector {String} to filter the descendants of the \n```\n       elements that trigger the event.\n```",
+                "type": "String"
+              },
+              {
+                "name": "options",
+                "description": "An optional options {Object} with an `data` key.",
+                "type": "Object"
+              },
+              {
+                "name": "handler",
+                "description": "A {Function} to execute when the command is triggered. ",
+                "type": "Function"
+              }
+            ]
+          }
         },
@@ -61,6 +86,21 @@ {
           "sectionName": null,
-          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.2/src/space-pen.coffee#L175",
+          "srcUrl": "https://github.com/atom/space-pen/blob/v3.4.3/src/space-pen.coffee#L176",
           "visibility": "Public",
           "summary": "Preempt events registered with jQuery's `::on`.",
-          "description": "Preempt events registered with jQuery's `::on`.\n\neventName - A event name {String}.\nhandler - A {Function} to execute when the eventName is triggered. "
+          "description": "Preempt events registered with jQuery's `::on`.",
+          "arguments": {
+            "description": "",
+            "list": [
+              {
+                "name": "eventName",
+                "description": "A event name {String}.",
+                "type": "String"
+              },
+              {
+                "name": "handler",
+                "description": "A {Function} to execute when the eventName is triggered. ",
+                "type": "Function"
+              }
+            ]
+          }
         }
@@ -70,5 +110,19 @@ ],
       "summary": "View class that extends the jQuery prototype.",
-      "description": "View class that extends the jQuery prototype.\n\nExtending classes must implement a `@content` method.\n\n## Example\n\n```coffee\nclass Spacecraft extends View\n  @content: ->\n    @div =>\n      @h1 'Spacecraft'\n      @ol =>\n        @li 'Apollo'\n        @li 'Soyuz'\n        @li 'Space Shuttle'\n```\n\nEach view instance will have all the methods from the jQuery prototype\navailable on it.\n\n```coffee\n  craft = new Spacecraft()\n  craft.find('h1').text() # 'Spacecraft'\n  craft.appendTo(document.body) # View is now a child of the <body> tag\n```"
+      "description": "View class that extends the jQuery prototype.\n\nExtending classes must implement a `@content` method.",
+      "examples": [
+        {
+          "description": "",
+          "lang": "coffee",
+          "code": "class Spacecraft extends View\n  @content: ->\n    @div =>\n      @h1 'Spacecraft'\n      @ol =>\n        @li 'Apollo'\n        @li 'Soyuz'\n        @li 'Space Shuttle'",
+          "raw": "```coffee\nclass Spacecraft extends View\n  @content: ->\n    @div =>\n      @h1 'Spacecraft'\n      @ol =>\n        @li 'Apollo'\n        @li 'Soyuz'\n        @li 'Space Shuttle'\n```"
+        },
+        {
+          "description": "Each view instance will have all the methods from the jQuery prototype\navailable on it.",
+          "lang": "coffee",
+          "code": "  craft = new Spacecraft()\n  craft.find('h1').text() # 'Spacecraft'\n  craft.appendTo(document.body) # View is now a child of the <body> tag",
+          "raw": "```coffee\n  craft = new Spacecraft()\n  craft.find('h1').text() # 'Spacecraft'\n  craft.appendTo(document.body) # View is now a child of the <body> tag\n```"
+        }
+      ]
     }
   }
 }

package.json

 {
   "name": "space-pen",
-  "version": "3.4.2",
+  "version": "3.4.3",
   "description": "Write markup on the final frontier",
@@ -5,0 +5,0 @@ "main": "./lib/space-pen.js",

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

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

278311

increased by0.55%

Lines of code

8133

increased by0.64%

No dependency changes