Describes a protobuf source file.

Hierarchy

  • DescFile

Properties

deprecated: boolean

Marked as deprecated in the protobuf source.

enums: DescEnum[]

Top-level enumerations declared in this file. Note that more enumerations might be declared within message declarations.

extensions: DescExtension[]

Top-level extensions declared in this file. Note that more extensions might be declared within message declarations.

kind: "file"
messages: DescMessage[]

Top-level messages declared in this file. Note that more messages might be declared within message declarations.

name: string

The name of the file, excluding the .proto suffix. For a protobuf file foo/bar.proto, this is foo/bar.

The compiler-generated descriptor.

services: DescService[]

Services declared in this file.

syntax: "proto3" | "proto2"

The syntax specified in the protobuf source.

Methods

  • Get comments on the package element in the protobuf source.

    Returns DescComments

  • Get comments on the syntax element in the protobuf source.

    Returns DescComments

  • Returns string

Generated using TypeDoc