Skip to main content

Class: FieldDescriptorProto

Describes a field within a message.

Properties​

defaultValue​

defaultValue: string

For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.

extendee​

extendee: string

For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

jsonName​

jsonName: string

JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

label​

label: Label

FieldDescriptorProto label.

name​

name: string

FieldDescriptorProto name.

number​

number: number

FieldDescriptorProto number.

oneofIndex​

oneofIndex: number

If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

options?​

optional options?: $Properties | null

FieldDescriptorProto options.

proto3Optional​

proto3Optional: boolean

If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.

When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs.

For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof.

Proto2 optional fields do not set this flag, because they already indicate optional with LABEL_OPTIONAL.

type​

type: Type

If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

typeName​

typeName: string

For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

Methods​

toJSON()​

toJSON(): object

Converts this FieldDescriptorProto to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): FieldDescriptorProto & $Shape

Creates a new FieldDescriptorProto instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

FieldDescriptorProto & $Shape

FieldDescriptorProto instance

Call Signature​

static create(properties?): FieldDescriptorProto

Creates a new FieldDescriptorProto instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

FieldDescriptorProto

FieldDescriptorProto instance

decode()​

static decode(reader, length?): FieldDescriptorProto & $Shape

Decodes a FieldDescriptorProto message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

FieldDescriptorProto & $Shape

FieldDescriptorProto

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): FieldDescriptorProto & $Shape

Decodes a FieldDescriptorProto message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

FieldDescriptorProto & $Shape

FieldDescriptorProto

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified FieldDescriptorProto message. Does not implicitly google.protobuf.FieldDescriptorProto.verify|verify messages.

Parameters​

message​

$Properties

FieldDescriptorProto message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified FieldDescriptorProto message, length delimited. Does not implicitly google.protobuf.FieldDescriptorProto.verify|verify messages.

Parameters​

message​

$Properties

FieldDescriptorProto message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): FieldDescriptorProto

Creates a FieldDescriptorProto message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

FieldDescriptorProto

FieldDescriptorProto

toObject()​

static toObject(message, options?): object

Creates a plain object from a FieldDescriptorProto message. Also converts values to other types if specified.

Parameters​

message​

FieldDescriptorProto

FieldDescriptorProto

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object