Interface DescFile

Describes a protobuf source file.

Hierarchy

  • DescFile

Properties

deprecated enums extensions kind messages name proto services syntax

Methods

getPackageComments getSyntaxComments toString

Properties

Readonly deprecated

deprecated: boolean

Marked as deprecated in the protobuf source.

Readonly enums

enums: DescEnum[]

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

Readonly extensions

extensions: DescExtension[]

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

kind

kind: "file"

Readonly messages

messages: DescMessage[]

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

Readonly name

name: string

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

Readonly proto

proto: FileDescriptorProto

The compiler-generated descriptor.

Readonly services

services: DescService[]

Services declared in this file.

Readonly syntax

syntax: "proto3" | "proto2"

The syntax specified in the protobuf source.

Methods

getPackageComments

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

    Returns DescComments

getSyntaxComments

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

    Returns DescComments

toString

  • Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc