FileDescriptorProto

google.protobuf. FileDescriptorProto

Represents a FileDescriptorProto.

Constructor

new FileDescriptorProto(propertiesopt)

Constructs a new FileDescriptorProto.

Parameters:
Name Type Attributes Description
properties google.protobuf.IFileDescriptorProto <optional>

Properties to set
Implements:
  • IFileDescriptorProto

Members

dependency :Array.<string>

FileDescriptorProto dependency.

enumType :Array.<google.protobuf.IEnumDescriptorProto>

FileDescriptorProto enumType.

extension :Array.<google.protobuf.IFieldDescriptorProto>

FileDescriptorProto extension.

messageType :Array.<google.protobuf.IDescriptorProto>

FileDescriptorProto messageType.

name :string

FileDescriptorProto name.

options :google.protobuf.IFileOptions|null|undefined

FileDescriptorProto options.

package :string

FileDescriptorProto package.

publicDependency :Array.<number>

FileDescriptorProto publicDependency.

service :Array.<google.protobuf.IServiceDescriptorProto>

FileDescriptorProto service.

sourceCodeInfo :google.protobuf.ISourceCodeInfo|null|undefined

FileDescriptorProto sourceCodeInfo.

syntax :string

FileDescriptorProto syntax.

weakDependency :Array.<number>

FileDescriptorProto weakDependency.

Methods

(static) create(propertiesopt) → {google.protobuf.FileDescriptorProto}

Creates a new FileDescriptorProto instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.protobuf.IFileDescriptorProto <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.protobuf.FileDescriptorProto}

Decodes a FileDescriptorProto message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.protobuf.FileDescriptorProto}

Decodes a FileDescriptorProto message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified FileDescriptorProto message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.protobuf.IFileDescriptorProto

FileDescriptorProto message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified FileDescriptorProto message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.protobuf.IFileDescriptorProto

FileDescriptorProto message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.protobuf.FileDescriptorProto}

Creates a FileDescriptorProto message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a FileDescriptorProto message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.protobuf.FileDescriptorProto

FileDescriptorProto
options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a FileDescriptorProto message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this FileDescriptorProto to JSON.