New: Generate named constructors for runtime messages, see #588

protobufjs · Jan 3, 2017 · cba46c3 · cba46c3
1 parent 196fdc0
commit cba46c3
Show file tree

Hide file tree

Showing 18 changed files with 90 additions and 37 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ npm-debug.*
 node_modules/
 docs/
 coverage/
+sandbox/
diff --git a/.npmignore b/.npmignore
@@ -5,6 +5,7 @@ npm-debug.*
 node_modules/
 docs/
 coverage/
+sandbox/
 examples/
 src/util/aspromise/
 src/util/base64/

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ protobuf.js
 
 **Protocol Buffers** are a language-neutral, platform-neutral, extensible way of serializing structured data for use in communications protocols, data storage, and more, originally designed at Google ([see](https://developers.google.com/protocol-buffers/)).
 
-**protobuf.js** is a pure JavaScript implementation for node and the browser. It efficiently encodes plain objects and custom classes and works out of the box with .proto files.
+**protobuf.js** is a pure JavaScript implementation with TypeScript support for node and the browser. It efficiently encodes plain objects and custom classes and works out of the box with .proto files.
 
 [travis-image]: https://img.shields.io/travis/dcodeIO/protobuf.js.svg
 [travis-url]: https://travis-ci.org/dcodeIO/protobuf.js

diff --git a/dist/noparse/protobuf.js b/dist/noparse/protobuf.js
diff --git a/dist/noparse/protobuf.js.map b/dist/noparse/protobuf.js.map
diff --git a/dist/noparse/protobuf.min.js b/dist/noparse/protobuf.min.js
diff --git a/dist/noparse/protobuf.min.js.gz b/dist/noparse/protobuf.min.js.gz
diff --git a/dist/noparse/protobuf.min.js.map b/dist/noparse/protobuf.min.js.map
diff --git a/dist/protobuf.js b/dist/protobuf.js
diff --git a/dist/protobuf.js.map b/dist/protobuf.js.map
diff --git a/dist/protobuf.min.js b/dist/protobuf.min.js
diff --git a/dist/protobuf.min.js.gz b/dist/protobuf.min.js.gz
diff --git a/dist/protobuf.min.js.map b/dist/protobuf.min.js.map
diff --git a/dist/runtime/protobuf.js b/dist/runtime/protobuf.js
diff --git a/dist/runtime/protobuf.min.js b/dist/runtime/protobuf.min.js
diff --git a/dist/runtime/protobuf.min.js.gz b/dist/runtime/protobuf.min.js.gz
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "protobufjs",
-  "version": "6.4.0",
+  "version": "6.4.1",
   "description": "Protocol Buffers for JavaScript (& TypeScript).",
   "author": "Daniel Wirtz <[email protected]>",
   "license": "BSD-3-Clause",

diff --git a/src/class.js b/src/class.js
@@ -36,11 +36,9 @@ function create(type, ctor) {
         if (typeof ctor !== "function")
             throw TypeError("ctor must be a function");
     } else
-        ctor = (function(MessageCtor) {
-            return function Message(properties) {
-                MessageCtor.call(this, properties);
-            };
-        })(Message);
+        ctor = util.codegen("p")("return ctor.call(this,p)").eof(type.name, {
+            ctor: Message
+        });
 
     // Let's pretend...
     ctor.constructor = Class;
@@ -97,6 +95,15 @@ Class.create = create;
 // Static methods on Message are instance methods on Class and vice versa.
 Class.prototype = Message;
 
+/**
+ * Creates a message from a JSON object by converting strings and numbers to their respective field types.
+ * @name Class#from
+ * @function
+ * @param {Object.<string,*>} object JSON object
+ * @param {MessageConversionOptions} [options] Options
+ * @returns {Message} Message instance
+ */
+
 /**
  * Encodes a message of this type.
  * @name Class#encode
@@ -138,3 +145,13 @@ Class.prototype = Message;
  * @param {Message|Object} message Message or plain object to verify
  * @returns {?string} `null` if valid, otherwise the reason why it is not
  */
+
+/**
+ * Converts an object or runtime message of this type.
+ * @name Class#convert
+ * @function
+ * @param {Message|Object} source Source object or runtime message
+ * @param {ConverterImpl} impl Converter implementation to use, i.e. {@link converters.json} or {@link converters.message}
+ * @param {Object.<string,*>} [options] Conversion options
+ * @returns {Message|Object} Converted object or runtime message
+ */