From f40a1ba99b540d67ea4cf627312158d91bf41122 Mon Sep 17 00:00:00 2001 From: Steve Ayers Date: Wed, 6 Mar 2024 11:14:57 -0500 Subject: [PATCH 1/2] Fix json serialization docs --- docs/runtime_api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/runtime_api.md b/docs/runtime_api.md index a04990877..a6e04b4f9 100644 --- a/docs/runtime_api.md +++ b/docs/runtime_api.md @@ -949,7 +949,7 @@ Options for `Message.fromBinary`: ### JSON serialization options -Options for `Message.fromJson` and `Message.fromJsonString`: +Options for `Message.toJson` and `Message.toJsonString`: - `emitDefaultValues?: boolean`
Fields with default values are omitted by default in JSON output. @@ -969,7 +969,7 @@ Options for `Message.fromJson` and `Message.fromJsonString`: option to `JSON.stringify`, which controls indentation for prettier output. See the [`JSON.stringify` docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#parameters). -Options for `Message.toJson` and `Message.toJsonString`: +Options for `Message.fromJson` and `Message.fromJsonString`: - `ignoreUnknownFields?: boolean`
By default, unknown properties are rejected. From cd6c967e34aca9b269c12ef6890e0235ccc3d8bb Mon Sep 17 00:00:00 2001 From: Steve Ayers Date: Wed, 6 Mar 2024 11:27:37 -0500 Subject: [PATCH 2/2] Docs --- docs/runtime_api.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/runtime_api.md b/docs/runtime_api.md index a6e04b4f9..d7370f18b 100644 --- a/docs/runtime_api.md +++ b/docs/runtime_api.md @@ -949,6 +949,16 @@ Options for `Message.fromBinary`: ### JSON serialization options +Options for `Message.fromJson` and `Message.fromJsonString`: + +- `ignoreUnknownFields?: boolean`
+ By default, unknown properties are rejected. + This option overrides this behavior and ignores properties, as + well as unrecognized enum string representations. +- `typeRegistry?: IMessageTypeRegistry & Partial`
+ A registry to parse [extensions](#extensions-and-json) and + [google.protobuf.Any](#any) from JSON. + Options for `Message.toJson` and `Message.toJsonString`: - `emitDefaultValues?: boolean`
@@ -969,16 +979,6 @@ Options for `Message.toJson` and `Message.toJsonString`: option to `JSON.stringify`, which controls indentation for prettier output. See the [`JSON.stringify` docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#parameters). -Options for `Message.fromJson` and `Message.fromJsonString`: - -- `ignoreUnknownFields?: boolean`
- By default, unknown properties are rejected. - This option overrides this behavior and ignores properties, as - well as unrecognized enum string representations. -- `typeRegistry?: IMessageTypeRegistry & Partial`
- A registry to parse [extensions](#extensions-and-json) and - [google.protobuf.Any](#any) from JSON. - ### JSON.stringify