Describes a complete .proto file.

Generated

from message google.protobuf.FileDescriptorProto

Hierarchy

Constructors

Properties

dependency: string[]

Names of files imported by this file.

Generated

from field: repeated string dependency = 3;

edition?: string

The edition of the proto file, which is an opaque string.

Generated

from field: optional string edition = 13;

Generated

from field: repeated google.protobuf.EnumDescriptorProto enum_type = 5;

Generated

from field: repeated google.protobuf.FieldDescriptorProto extension = 7;

messageType: DescriptorProto[]

All top-level definitions in this file.

Generated

from field: repeated google.protobuf.DescriptorProto message_type = 4;

name?: string

file name, relative to root of source tree

Generated

from field: optional string name = 1;

options?: FileOptions

Generated

from field: optional google.protobuf.FileOptions options = 8;

package?: string

e.g. "foo", "foo.bar", etc.

Generated

from field: optional string package = 2;

publicDependency: number[]

Indexes of the public imported files in the dependency list above.

Generated

from field: repeated int32 public_dependency = 10;

Generated

from field: repeated google.protobuf.ServiceDescriptorProto service = 6;

sourceCodeInfo?: SourceCodeInfo

This field contains optional information about the original source code. You may safely remove this entire field without harming runtime functionality of the descriptors -- the information is needed only by development tools.

Generated

from field: optional google.protobuf.SourceCodeInfo source_code_info = 9;

syntax?: string

The syntax of the proto file. The supported values are "proto2", "proto3", and "editions".

If edition is present, this value must be "editions".

Generated

from field: optional string syntax = 12;

weakDependency: number[]

Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use.

Generated

from field: repeated int32 weak_dependency = 11;

fields: FieldList
runtime: ProtoRuntime
typeName: "google.protobuf.FileDescriptorProto" = "google.protobuf.FileDescriptorProto"

Methods

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, 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.

    Parameters

    Returns FileDescriptorProto

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<FileDescriptorProto>

  • Serialize the message to binary data.

    Parameters

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    Returns string

  • Parameters

    Returns FileDescriptorProto

  • Parameters

    Returns FileDescriptorProto

Generated using TypeDoc