Skip to content

Commit

Permalink
Other: Split up NamespaceDescriptor to make nested plain namespaces a…
Browse files Browse the repository at this point in the history
… thing, see #749
  • Loading branch information
dcodeIO committed Apr 5, 2017
1 parent 1f76749 commit a7621be
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 15 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Where bundle size is a factor, there are additional stripped-down versions of th
Usage
-----

Because JavaScript is a dynamically typed language, protobuf.js introduces the concept of a **valid message** in order to provide the best possible [performance](#performance):
Because JavaScript is a dynamically typed language, protobuf.js introduces the concept of a **valid message** in order to provide the best possible [performance](#performance) (and, as a side product, proper typings):

### Valid message

Expand All @@ -119,8 +119,8 @@ There are two possible types of valid messages and the encoder is able to work w

In a nutshell, the wire format writer understands the following types:

| Field type | Expected JS type (create, encode) | Naive conversion (fromObject)
|------------|-----------------------------------|------------------------------
| Field type | Expected JS type (create, encode) | Conversion (fromObject)
|------------|-----------------------------------|------------------------
| s-/u-/int32<br />s-/fixed32 | `number` (32 bit integer) | `value | 0` if signed<br /> `value >>> 0` if unsigned
| s-/u-/int64<br />s-/fixed64 | `Long`-like (optimal)<br />`number` (53 bit integer) | `Long.fromValue(value)` with long.js<br />`parseInt(value, 10)` otherwise
| float<br />double | `number` | `Number(value)`
Expand Down Expand Up @@ -187,7 +187,7 @@ With that in mind and again for performance reasons, each message class provides
```

* **Message.fromObject**(object: `Object`): `Message`<br />
naively converts any non-valid **plain JavaScript object** to a **message instance**. See the table above for the exact conversion operations performed.
converts any non-valid **plain JavaScript object** to a **message instance** using the conversion steps outlined within the table above.

```js
var message = AwesomeMessage.fromObject({ awesomeField: 42 });
Expand All @@ -213,6 +213,8 @@ For reference, the following diagram aims to display the relationships between t

<img alt="Toolset Diagram" src="http://dcode.io/protobuf.js/toolset.svg" />

> In other words: `verify` indicates that calling `create` or `encode` directly on the plain object will [result in a valid message respectively] succeed. `fromObject`, on the other hand, does conversion from a broader range of plain objects to create valid messages. ([ref](https://github.com/dcodeIO/protobuf.js/issues/748#issuecomment-291925749))

Examples
--------

Expand Down Expand Up @@ -247,7 +249,7 @@ protobuf.load("awesome.proto", function(err, root) {
throw Error(errMsg);
// Create a new message
var message = AwesomeMessage.fromObject(payload); // or use .create if payload is already known to be valid
var message = AwesomeMessage.creeate(payload); // or use .fromObject if conversion is necessary
// Encode a message to an Uint8Array (browser) or Buffer (node)
var buffer = AwesomeMessage.encode(message).finish();
Expand Down
15 changes: 11 additions & 4 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -880,9 +880,9 @@ export abstract class NamespaceBase extends ReflectionObject {

/**
* Converts this namespace to a namespace descriptor.
* @returns {NamespaceDescriptor} Namespace descriptor
* @returns {NamespaceBaseDescriptor} Namespace descriptor
*/
public toJSON(): NamespaceDescriptor;
public toJSON(): NamespaceBaseDescriptor;

/**
* Adds nested objects to this namespace from nested object descriptors.
Expand Down Expand Up @@ -996,13 +996,20 @@ export abstract class NamespaceBase extends ReflectionObject {
public lookupService(path: (string|string[])): Service;
}

type AnyNestedDescriptor = (EnumDescriptor|TypeDescriptor|ServiceDescriptor|ExtensionFieldDescriptor|ExtensionMapFieldDescriptor);

type NamespaceDescriptor = {
options?: { [k: string]: any };
nested: { [k: string]: AnyNestedDescriptor };
};

type NamespaceBaseDescriptor = {
options?: { [k: string]: any };
nested?: { [k: string]: AnyNestedDescriptor };
};

type AnyExtensionFieldDescriptor = (ExtensionFieldDescriptor|ExtensionMapFieldDescriptor);

type AnyNestedDescriptor = (EnumDescriptor|TypeDescriptor|ServiceDescriptor|AnyExtensionFieldDescriptor|NamespaceDescriptor);

/**
* Constructs a new reflection object instance.
* @classdesc Base class of all reflection objects.
Expand Down
27 changes: 21 additions & 6 deletions src/namespace.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,22 +98,37 @@ Object.defineProperty(Namespace.prototype, "nestedArray", {
});

/**
* Any nested object descriptor.
* @typedef AnyNestedDescriptor
* @type {EnumDescriptor|TypeDescriptor|ServiceDescriptor|ExtensionFieldDescriptor|ExtensionMapFieldDescriptor}
* Namespace descriptor.
* @typedef NamespaceDescriptor
* @type {Object}
* @property {Object.<string,*>} [options] Namespace options
* @property {Object.<string,AnyNestedDescriptor>} nested Nested object descriptors
*/

/**
* Namespace descriptor.
* @typedef NamespaceDescriptor
* Namespace base descriptor.
* @typedef NamespaceBaseDescriptor
* @type {Object}
* @property {Object.<string,*>} [options] Namespace options
* @property {Object.<string,AnyNestedDescriptor>} [nested] Nested object descriptors
*/

/**
* Any extension field descriptor.
* @typedef AnyExtensionFieldDescriptor
* @type {ExtensionFieldDescriptor|ExtensionMapFieldDescriptor}
*/

/**
* Any nested object descriptor.
* @typedef AnyNestedDescriptor
* @type {EnumDescriptor|TypeDescriptor|ServiceDescriptor|AnyExtensionFieldDescriptor|NamespaceDescriptor}
*/
// ^ BEWARE: VSCode hangs forever when using more than 5 types (that's why AnyExtensionFieldDescriptor exists in the first place)

/**
* Converts this namespace to a namespace descriptor.
* @returns {NamespaceDescriptor} Namespace descriptor
* @returns {NamespaceBaseDescriptor} Namespace descriptor
*/
Namespace.prototype.toJSON = function toJSON() {
return {
Expand Down

0 comments on commit a7621be

Please sign in to comment.