Interface JsonFormat

JsonFormat is the contract for serializing messages to and from JSON. Implementations may be specific to a proto syntax, and can be reflection based, or delegate to speed optimized generated code.

Hierarchy

JsonFormat

Index

Methods

debug makeReadOptions makeWriteOptions readMessage readScalar writeMessage writeScalar

Methods

debug

debug(json): string
Returns a short string representation of a JSON value, suitable for error messages.
Parameters
- json: JsonValue
Returns string
- Defined in node_modules/.pnpm/@bufbuild+protobuf@1.2.0/node_modules/@bufbuild/protobuf/dist/types/json-format.d.ts:40

makeReadOptions

makeReadOptions(options?): Readonly<JsonReadOptions>
Provide options for parsing JSON data.
Parameters
- Optional options: Partial<JsonReadOptions>
Returns Readonly<JsonReadOptions>
- Defined in node_modules/.pnpm/@bufbuild+protobuf@1.2.0/node_modules/@bufbuild/protobuf/dist/types/json-format.d.ts:14

makeWriteOptions

makeWriteOptions(options?): Readonly<JsonWriteStringOptions>
Provide options for serializing to JSON.
Parameters
- Optional options: Partial<JsonWriteStringOptions>
Returns Readonly<JsonWriteStringOptions>
- Defined in node_modules/.pnpm/@bufbuild+protobuf@1.2.0/node_modules/@bufbuild/protobuf/dist/types/json-format.d.ts:18

readMessage

readMessage<T>(type, jsonValue, options, message?): T
Parse a message from JSON.
Type Parameters
- T extends Message<T, T>
Parameters
- type: MessageType<T>
- jsonValue: JsonValue
- options: JsonReadOptions
- Optional message: T
Returns T
- Defined in node_modules/.pnpm/@bufbuild+protobuf@1.2.0/node_modules/@bufbuild/protobuf/dist/types/json-format.d.ts:22

readScalar

readScalar(type, json): any
Parse a single scalar value from JSON. This method may throw an error, but it may have a blank error message. Callers are expected to provide context.
Parameters
- type: ScalarType
- json: JsonValue
Returns any
- Defined in node_modules/.pnpm/@bufbuild+protobuf@1.2.0/node_modules/@bufbuild/protobuf/dist/types/json-format.d.ts:32

writeMessage

writeMessage(message, options): JsonValue
Serialize a message to JSON.
Parameters
- message: Message<AnyMessage>
- options: JsonWriteOptions
Returns JsonValue
- Defined in node_modules/.pnpm/@bufbuild+protobuf@1.2.0/node_modules/@bufbuild/protobuf/dist/types/json-format.d.ts:26

writeScalar

writeScalar(type, value, emitDefaultValues): undefined | JsonValue
Serialize a single scalar value to JSON.
Parameters
- type: ScalarType
- value: any
- emitDefaultValues: boolean
Returns undefined | JsonValue
- Defined in node_modules/.pnpm/@bufbuild+protobuf@1.2.0/node_modules/@bufbuild/protobuf/dist/types/json-format.d.ts:36

Generated using TypeDoc