You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
57 lines
2.2 KiB
57 lines
2.2 KiB
2 months ago
|
import { type DescEnum, type DescMessage } from "./descriptors.js";
|
||
|
|
import type { JsonValue } from "./json-value.js";
|
||
|
|
import type { Registry } from "./registry.js";
|
||
|
|
import type { EnumJsonType, EnumShape, MessageShape } from "./types.js";
|
||
|
|
/**
|
||
|
|
* Options for parsing JSON data.
|
||
|
|
*/
|
||
|
|
export interface JsonReadOptions {
|
||
|
|
/**
|
||
|
|
* Ignore unknown fields: Proto3 JSON parser should reject unknown fields
|
||
|
|
* by default. This option ignores unknown fields in parsing, as well as
|
||
|
|
* unrecognized enum string representations.
|
||
|
|
*/
|
||
|
|
ignoreUnknownFields: boolean;
|
||
|
|
/**
|
||
|
|
* This option is required to read `google.protobuf.Any` and extensions
|
||
|
|
* from JSON format.
|
||
|
|
*/
|
||
|
|
registry?: Registry;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Parse a message from a JSON string.
|
||
|
|
*/
|
||
|
|
export declare function fromJsonString<Desc extends DescMessage>(schema: Desc, json: string, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
|
||
|
|
/**
|
||
|
|
* Parse a message from a JSON string, merging fields.
|
||
|
|
*
|
||
|
|
* Repeated fields are appended. Map entries are added, overwriting
|
||
|
|
* existing keys.
|
||
|
|
*
|
||
|
|
* If a message field is already present, it will be merged with the
|
||
|
|
* new data.
|
||
|
|
*/
|
||
|
|
export declare function mergeFromJsonString<Desc extends DescMessage>(schema: Desc, target: MessageShape<Desc>, json: string, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
|
||
|
|
/**
|
||
|
|
* Parse a message from a JSON value.
|
||
|
|
*/
|
||
|
|
export declare function fromJson<Desc extends DescMessage>(schema: Desc, json: JsonValue, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
|
||
|
|
/**
|
||
|
|
* Parse a message from a JSON value, merging fields.
|
||
|
|
*
|
||
|
|
* Repeated fields are appended. Map entries are added, overwriting
|
||
|
|
* existing keys.
|
||
|
|
*
|
||
|
|
* If a message field is already present, it will be merged with the
|
||
|
|
* new data.
|
||
|
|
*/
|
||
|
|
export declare function mergeFromJson<Desc extends DescMessage>(schema: Desc, target: MessageShape<Desc>, json: JsonValue, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
|
||
|
|
/**
|
||
|
|
* Parses an enum value from JSON.
|
||
|
|
*/
|
||
|
|
export declare function enumFromJson<Desc extends DescEnum>(descEnum: Desc, json: EnumJsonType<Desc>): EnumShape<Desc>;
|
||
|
|
/**
|
||
|
|
* Is the given value a JSON enum value?
|
||
|
|
*/
|
||
|
|
export declare function isEnumJson<Desc extends DescEnum>(descEnum: Desc, value: unknown): value is EnumJsonType<Desc>;
|