Class: DescriptorProto
google.protobuf.DescriptorProto
Describes a message type.
Properties
enumType
• enumType: $Properties[]
DescriptorProto enumType.
extension
• extension: $Properties[]
DescriptorProto extension.
extensionRange
• extensionRange: $Properties[]
DescriptorProto extensionRange.
field
• field: $Properties[]
DescriptorProto field.
name
• name: string
DescriptorProto name.
nestedType
• nestedType: $Properties[]
DescriptorProto nestedType.
oneofDecl
• oneofDecl: $Properties[]
DescriptorProto oneofDecl.
options
• Optional options: null | $Properties
DescriptorProto options.
reservedName
• reservedName: string[]
Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.
reservedRange
• reservedRange: $Properties[]
DescriptorProto reservedRange.
Methods
toJSON
▸ toJSON(): Object
Converts this DescriptorProto to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescriptorProto & $Shape
Creates a new DescriptorProto instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
DescriptorProto instance
▸ create(properties?): DescriptorProto
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DescriptorProto & $Shape
Decodes a DescriptorProto message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
DescriptorProto
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescriptorProto & $Shape
Decodes a DescriptorProto message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescriptorProto
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified DescriptorProto message. Does not implicitly google.protobuf.DescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescriptorProto message, length delimited. Does not implicitly google.protobuf.DescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescriptorProto
Creates a DescriptorProto message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescriptorProto
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescriptorProto message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescriptorProto | DescriptorProto |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object