From a5dbba41341bf44876cd4226f08044f88148f37d Mon Sep 17 00:00:00 2001 From: dcodeIO Date: Thu, 23 Mar 2017 19:44:53 +0100 Subject: [PATCH] Docs: Added 'What is a valid message' section to README [ci skip] --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f9045fb5..5a78b3ffc 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Each message type provides a set of methods with each method doing just one thin Note that **Message** refers to any message type below. * **Message.verify**(message: `Object`): `null|string`
- explicitly performs verification prior to encoding / converting a plain object. Instead of throwing, it returns the error message as a string, if any. + explicitly performs verification prior to encoding a plain object. Instead of throwing, it returns the error message as a string, if any. ```js var payload = "invalid (not an object)"; @@ -160,6 +160,30 @@ Note that **Message** refers to any message type below. See also: [ConversionOptions](http://dcode.io/protobuf.js/global.html#ConversionOptions) +**What is a valid message?** + +A valid message is an object not missing any required fields and exclusively using JS types for its fields that are understood by the wire format writer. + +* Calling `Message.verify` with a valid message returns `null` and otherwise the error as a string. +* Calling `Message.create` or `Message.encode` with any object assumes valid types. +* Calling `Message.fromObject` with any object naively converts all values to the optimal JS type. + +| Type | Expected JS type (create) | Naive conversion (fromObject) +|--------|-----------------|------------------- +| int32
uint32
sint32
fixed32
sfixed32 | `Number` (32 bit integer) | `value | 0`
`value >>> 0` +| int64
uint64
sint64
fixed64
sfixed64 | `Long`-like (optimal)
`Number` (53 bit integer) | `Long.fromValue(value)`
`parseInt(value, 10)` without long.js +| float
double | `Number` | `Number(value)` +| bool | `Boolean` | `Boolean(value)` +| string | `String` | `String(value)` +| bytes | `Uint8Array` (optimal)
`Buffer` (optimal)
`Array.` (8 bit integers)
`String` (base64) | `base64.decode(value)` if a String
`Object` with non-zero `.length` is kept +| enum | `Number` (32 bit integer) | Looks up the numeric id if a string +| message | Valid message | `Message.fromObject(value)` + +* Explicit `undefined` and `null` are considered as not set when optional. +* Repeated fields are `Array.`. +* Map fields are `Object.` with the key being the string representation of the respective value or an 8 characters long binary hash string for Long-likes. +* `String` refers to both objects and values while `Number` refers to values only. + Examples --------