Constructor
new DescriptorProto(propertiesopt)
Constructs a new DescriptorProto.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.protobuf.IDescriptorProto |
<optional> |
Properties to set |
- Implements:
-
- IDescriptorProto
Classes
Members
enumType
DescriptorProto enumType.
extension
DescriptorProto extension.
extensionRange
DescriptorProto extensionRange.
field
DescriptorProto field.
name
DescriptorProto name.
nestedType
DescriptorProto nestedType.
oneofDecl
DescriptorProto oneofDecl.
options
DescriptorProto options.
reservedName
DescriptorProto reservedName.
reservedRange
DescriptorProto reservedRange.
Methods
toJSON() → {Object.<string, *>}
Converts this DescriptorProto to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(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 |
Returns:
| Type | Description |
|---|---|
| google.protobuf.DescriptorProto |
DescriptorProto instance |
(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 |
Returns:
| Type | Description |
|---|---|
| google.protobuf.DescriptorProto |
DescriptorProto |
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 |
Returns:
| Type | Description |
|---|---|
| google.protobuf.DescriptorProto |
DescriptorProto |
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 |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(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 |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(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 |
Returns:
| Type | Description |
|---|---|
| google.protobuf.DescriptorProto |
DescriptorProto |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for DescriptorProto
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 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 |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a DescriptorProto message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|