protobuf.js

API documentation

Class: FieldBase

FieldBase

Base class of all reflected message fields. This is not an actual class but here for the sake of having consistent type definitions.

new FieldBase(name, id, type, rule, extend, options)

src/field.js, line 54

Not an actual constructor. Use Field instead.

Name Type Default Description
name string

Unique name within its namespace
id number

Unique id within its namespace
type string

Value type
rule string | Object.<string, *> "optional" optional

Field rule
extend string | Object.<string, *> optional

Extended type if different from parent
options Object.<string, *> optional

Declared options

Extends

Members

bytes { boolean }

Whether this field's value is a buffer.

comment { string | null }

Comment text, if any.

declaringField { Field | null }

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

defaultValue { * }

The field's default value on prototypes.

extend { string | undefined }

Extended type if different from parent.

extensionField { Field | null }

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

filename { string | null }

Defining file name.

fullName readonly{ string }

Full name including leading dot.

id { number }

Unique field id.

long { boolean }

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

map { boolean }

Whether this field is a map or not.

message { Type | null }

Message this field belongs to.

name { string }

Unique name within its namespace.

optional { boolean }

Whether this field is optional.

options { Object<string, *> | undefined }

Options.

parent { Namespace | null }

Parent namespace.

partOf { OneOf | null }

OneOf this field belongs to, if any,

repeated { boolean }

Whether this field is repeated.

required { boolean }

Whether this field is required.

resolved { boolean }

Whether already resolved or not.

resolvedType { Type | Enum | null }

Resolved type if not a basic type.

root readonly{ Root }

Reference to the root namespace.

rule { string | undefined }

Field rule, if any.

type { string }

Field type.

typeDefault { * }

The field type's default value.

Methods

inherited getOption(name){ * }

src/object.js, line 153

Gets an option value.

Name Type Description
name string

Option name
Returns:
Type Description
* Option value or undefined if not set

inherited onAdd(parent){ undefined }

src/object.js, line 113

Called when this object is added to a parent.

Name Type Description
parent ReflectionObject

Parent added to
Returns:
Type Description
undefined

inherited onRemove(parent){ undefined }

src/object.js, line 128

Called when this object is removed from a parent.

Name Type Description
parent ReflectionObject

Parent removed from
Returns:
Type Description
undefined

resolve(){ Field }

src/field.js, line 247

Resolves this field's type references.

Throws:
Type Description
Error

If any reference cannot be resolved
Returns:
Type Description
Field this

inherited setOption(name, value, ifNotSet){ ReflectionObject }

src/object.js, line 166

Sets an option.

Name Type Description
name string

Option name
value *

Option value
ifNotSet boolean optional

Sets the option only if it isn't currently set
Returns:
Type Description
ReflectionObject this

inherited setOptions(options, ifNotSet){ ReflectionObject }

src/object.js, line 178

Sets multiple options.

Name Type Description
options Object.<string, *>

Options to set
ifNotSet boolean optional

Sets an option only if it isn't currently set
Returns:
Type Description
ReflectionObject this

toJSON(){ IField }

src/field.js, line 232

Converts this field to a field descriptor.

Returns:
Type Description
IField Field descriptor

inherited toString(){ string }

src/object.js, line 189

Converts this instance to its string representation.

Returns:
Type Description
string Class name[, space, full name]