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

FileDescriptorProto dependency.

edition

FileDescriptorProto edition.

enumType

FileDescriptorProto enumType.

extension

FileDescriptorProto extension.

messageType

FileDescriptorProto messageType.

name

FileDescriptorProto name.

options

FileDescriptorProto options.

package

FileDescriptorProto package.

publicDependency

FileDescriptorProto publicDependency.

service

FileDescriptorProto service.

sourceCodeInfo

FileDescriptorProto sourceCodeInfo.

syntax

FileDescriptorProto syntax.

weakDependency

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
Returns:
Type Description
google.protobuf.FileDescriptorProto

FileDescriptorProto instance

(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
Returns:
Type Description
google.protobuf.FileDescriptorProto

FileDescriptorProto
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
Returns:
Type Description
google.protobuf.FileDescriptorProto

FileDescriptorProto
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
Returns:
Type Description
$protobuf.Writer

Writer

(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
Returns:
Type Description
$protobuf.Writer

Writer

(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
Returns:
Type Description
google.protobuf.FileDescriptorProto

FileDescriptorProto

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FileDescriptorProto

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(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
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a FileDescriptorProto message.

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

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

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

Converts this FileDescriptorProto to JSON.

Returns:
Type Description
Object.<string, *>

JSON object