Class: OneofDescriptorProto
google.protobuf.OneofDescriptorProto
Describes a oneof.
Implements
Constructors
constructor
• new OneofDescriptorProto(properties?): OneofDescriptorProto
Constructs a new OneofDescriptorProto.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOneofDescriptorProto | Properties to set |
Returns
Properties
name
• name: string
OneofDescriptorProto name.
Implementation of
options
• Optional options: null | IOneofOptions
OneofDescriptorProto options.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this OneofDescriptorProto to JSON.
Returns
Object
JSON object
create
▸ create(properties?): OneofDescriptorProto
Creates a new OneofDescriptorProto instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOneofDescriptorProto | Properties to set |
Returns
OneofDescriptorProto instance
decode
▸ decode(reader, length?): OneofDescriptorProto
Decodes an OneofDescriptorProto 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
OneofDescriptorProto
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): OneofDescriptorProto
Decodes an OneofDescriptorProto message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
OneofDescriptorProto
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 OneofDescriptorProto message. Does not implicitly google.protobuf.OneofDescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOneofDescriptorProto | OneofDescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified OneofDescriptorProto message, length delimited. Does not implicitly google.protobuf.OneofDescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOneofDescriptorProto | OneofDescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): OneofDescriptorProto
Creates an OneofDescriptorProto message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
OneofDescriptorProto
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for OneofDescriptorProto
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from an OneofDescriptorProto message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | OneofDescriptorProto | OneofDescriptorProto |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object