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