Changes between Version 13 and Version 14 of WebInspectorCodingStyleGuide

Timestamp:

May 27, 2015 10:58:42 AM (9 years ago)

Author:

Brian Burg

Comment:

Fix class skeleton to use ES6 class syntax; promise nit

WebInspectorCodingStyleGuide

@@ -46 +46 @@
 
 1. Become __fulfilled__ by a **value**
-2. Become __rejected__ with an **exception**
+2. Become __rejected__ with an **Error instance** or by throwing an exception
 
 And, if you have a correctly implemented `then()` function, then fulfillment and rejection will compose just like their synchronous counterparts, with fulfillments flowing up a compositional chain, but being interrupted at any time by a rejection that is only handled by someone who declares they are ready to handle it.
@@ -66 +66 @@
 == New class skeleton
 
-The new Inspector object classes should have the following format:
+New Inspector object classes use ES6 class syntax and should have the following format:
+
+{{{
+WebInspector.NewObjectType = class NewObjectType extends WebInspector.Object {
+    constructor(param)
+    {
+        WebInspector.Object.call(this);
+       this._propertyName = param;
+    }
+
+    // Public
+
+    get propertyName()
+    {
+        return this._propertyName;
+    }
+
+    set propertyName(value)
+    {
+        this._propertyName = value;
+        this.dispatchEventToListeners(WebInspector.NewObjectType.Event.PropertyWasChanged);
+    }
+
+    publicMethod: function()
+    {
+        /* public methods called outside the class */
+    }
+
+    // Protected
+
+    handleEvent: function(event)
+    {
+        /* delegate methods, event handlers, and overrides. */
+    }
+
+    // Private
+
+    _privateMethod: function()
+    {
+        /* private methods are underscore prefixed */
+    }
+};
+
+WebInspector.NewObjectType.Event = {
+    PropertyWasChanged: "new-object-type-property-was-changed"
+};
+
+}}}
+
+== Old class skeleton
+
+Some existing Inspector object classes have not been converted to ES6 classes. The should conform to the following format:
 
 {{{