DescriptorProto

google.protobuf. DescriptorProto

Represents a DescriptorProto.

Constructor

new DescriptorProto(propertiesopt)

Constructs a new DescriptorProto.

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

Properties to set
Implements:
  • IDescriptorProto

Classes

ExtensionRange
ReservedRange

Members

enumType :Array.<google.protobuf.IEnumDescriptorProto>

DescriptorProto enumType.

extension :Array.<google.protobuf.IFieldDescriptorProto>

DescriptorProto extension.

extensionRange :Array.<google.protobuf.DescriptorProto.IExtensionRange>

DescriptorProto extensionRange.

field :Array.<google.protobuf.IFieldDescriptorProto>

DescriptorProto field.

name :string

DescriptorProto name.

nestedType :Array.<google.protobuf.IDescriptorProto>

DescriptorProto nestedType.

oneofDecl :Array.<google.protobuf.IOneofDescriptorProto>

DescriptorProto oneofDecl.

options :google.protobuf.IMessageOptions|null|undefined

DescriptorProto options.

reservedName :Array.<string>

DescriptorProto reservedName.

reservedRange :Array.<google.protobuf.DescriptorProto.IReservedRange>

DescriptorProto reservedRange.

Methods

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

Creates a new DescriptorProto instance using the specified properties.

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

Properties to set

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

Decodes a DescriptorProto 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.DescriptorProto}

Decodes a DescriptorProto 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 DescriptorProto message. Does not implicitly verify messages.

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

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

Writer to encode to

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

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

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

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

Writer to encode to

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

Creates a DescriptorProto 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 DescriptorProto message. Also converts values to other types if specified.

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

DescriptorProto
options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a DescriptorProto message.

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

Plain object to verify

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

Converts this DescriptorProto to JSON.