Class: Field

Extends

• FieldBase

Members

bytes { boolean }

field.js, line 158

Whether this field's value is a buffer.

comment { string | null }

field.js, line 182

Comment for this field.

declaringField { Field | null }

field.js, line 176

Sister-field within the declaring namespace if an extended field.

defaultValue { * }

field.js, line 146

The field's default value on prototypes.

delimited readonly{ boolean }

field.js, line 209

Determines whether this field uses tag-delimited encoding. In proto2 this
corresponded to group syntax.

extend { string | undefined }

field.js, line 110

Extended type if different from parent.

extensionField { Field | null }

field.js, line 170

Sister-field within the extended type if a declaring extension field.

filename { string | null }

object.js, line 103

Defining file name.

fullName readonly{ string }

object.js, line 123

Full name including leading dot.

hasPresence readonly{ boolean }

field.js, line 235

Determines whether this field tracks presence.

id { number }

field.js, line 104

Unique field id.

long { boolean }

field.js, line 152

Whether this field's value should be treated as a long.

map { boolean }

field.js, line 122

Whether this field is a map or not.

message { Type | null }

field.js, line 128

Message this field belongs to.

name { string }

object.js, line 50

Unique name within its namespace.

optional readonly{ boolean }

field.js, line 197

Determines whether this field is not required.

options { Object<string, *> | undefined }

object.js, line 38

Options.

packed readonly{ boolean }

field.js, line 223

Determines whether this field is packed. Only relevant when repeated.

parent { Namespace | null }

object.js, line 85

Parent namespace.

parsedOptions { Object<string, *>[] | undefined }

object.js, line 44

Parsed Options.

partOf { OneOf | null }

field.js, line 134

OneOf this field belongs to, if any,

repeated { boolean }

field.js, line 116

Whether this field is repeated.

required readonly{ boolean }

field.js, line 185

Determines whether this field is required.

resolved { boolean }

object.js, line 91

Whether already resolved or not.

resolvedType { Type | Enum | null }

field.js, line 164

Resolved type if not a basic type.

root readonly{ Root }

object.js, line 108

Reference to the root namespace.

type { string }

field.js, line 98

Field type.

typeDefault { * }

field.js, line 140

The field type's default value.

Methods

inherited getOption(name)→{ * }

object.js, line 272

Gets an option value.

Parameters:

name

string

Option name

Returns:

*	Option value or undefined if not set

inherited onAdd(parent)→{ undefined }

object.js, line 155

Called when this object is added to a parent.

Parameters:

parent

ReflectionObject

Parent added to

Returns:

undefined

inherited onRemove(parent)→{ undefined }

object.js, line 170

Called when this object is removed from a parent.

Parameters:

parent

ReflectionObject

Parent removed from

Returns:

undefined

inherited resolve()→{ Field }

field.js, line 300

Resolves this field's type references.

Throws:

Error

If any reference cannot be resolved

Returns:

Field

this

inherited setOptions(options, ifNotSet)→{ ReflectionObject }

object.js, line 347

Sets multiple options.

Parameters:

options	Object.<string, *>	Options to set
ifNotSet	boolean	optional Sets an option only if it isn't currently set

Returns:

ReflectionObject

this

inherited setParsedOption(name, value, propName)→{ ReflectionObject }

object.js, line 307

Sets a parsed option.

Parameters:

name	string	parsed Option name
value	*	Option value
propName	string	dot '.' delimited full path of property within the option to set. if undefined\empty, will add a new option with that value

Returns:

ReflectionObject

this

inherited toJSON(toJSONOptions)→{ IField }

field.js, line 282

Converts this field to a field descriptor.

Parameters:

toJSONOptions

IToJSONOptions

optional JSON conversion options

Returns:

IField

Field descriptor

inherited toString()→{ string }

object.js, line 358

Converts this instance to its string representation.

Returns:

string

Class name[, space, full name]

Field.d(fieldId, fieldType, fieldRule, defaultValue)→{ FieldDecorator }

field.js, line 413

Field decorator (TypeScript).

Parameters:

fieldId	number		Field id
fieldType	"double" | "float" | "int32" | "uint32" | "sint32" | "fixed32" | "sfixed32" | "int64" | "uint64" | "sint64" | "fixed64" | "sfixed64" | "string" | "bool" | "bytes" | Object		Field type
fieldRule	"optional" | "required" | "repeated"	"optional"	optional Field rule
defaultValue	T		optional Default value

Deprecated:

Legacy TypeScript decorator support. Will be removed in a future release.

Returns:

FieldDecorator

Decorator function

Field.d(2)(fieldId, fieldType, fieldRule)→{ FieldDecorator }

field.js, line 446

Field decorator (TypeScript).

Parameters:

fieldId	number		Field id
fieldType	Constructor.<T> | string		Field type
fieldRule	"optional" | "required" | "repeated"	"optional"	optional Field rule

Deprecated:

Legacy TypeScript decorator support. Will be removed in a future release.

Returns:

FieldDecorator

Decorator function

Field.fromJSON(name, json)→{ Field }

field.js, line 37

Constructs a field from a field descriptor.

Parameters:

name	string	Field name
json	IField	Field descriptor

Throws:

TypeError

If arguments are invalid

Returns:

Field

Created field