protobuf.js

API documentation

Class: OneOf

OneOf

Reflected oneof.

new OneOf(name, fieldNames, options, comment)

oneof.js, line 21

Constructs a new oneof instance.

Name Type Description
name string

Oneof name
fieldNames Array.<string> | Object.<string, *> optional

Field names
options Object.<string, *> optional

Declared options
comment string optional

Comment associated with this field

Extends

Members

comment { string | null }

Comment for this field.

fieldsArray readonly{ Field[] }

Fields that belong to this oneof as an array for iteration.

filename { string | null }

Defining file name.

fullName readonly{ string }

Full name including leading dot.

isProto3Optional readonly{ boolean }

Determines whether this field corresponds to a synthetic oneof created for
a proto3 optional field. No behavioral logic should depend on this, but it
can be relevant for reflection.

name { string }

Unique name within its namespace.

oneof { string[] }

Field names that belong to this oneof.

options { Object<string, *> | undefined }

Options.

parent { Namespace | null }

Parent namespace.

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

Parsed Options.

resolved { boolean }

Whether already resolved or not.

root readonly{ Root }

Reference to the root namespace.

Methods

add(field){ OneOf }

oneof.js, line 103

Adds a field to this oneof and removes it from its current parent, if any.

Name Type Description
field Field

Field to add
Returns:
Type Description
OneOf this

inherited getOption(name){ * }

object.js, line 273

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 }

oneof.js, line 149

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 }

oneof.js, line 167

Called when this object is removed from a parent.

Name Type Description
parent ReflectionObject

Parent removed from
Returns:
Type Description
undefined

remove(field){ OneOf }

oneof.js, line 123

Removes a field from this oneof and puts it back to the oneof's parent.

Name Type Description
field Field

Field to remove
Returns:
Type Description
OneOf this

inherited resolve(){ ReflectionObject }

object.js, line 183

Resolves this objects type references.

Returns:
Type Description
ReflectionObject this

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

object.js, line 286

Sets an option.

Name Type Description
name string

Option name
value *

Option value
ifNotSet boolean | undefined optional

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

inherited setOptions(options, ifNotSet){ ReflectionObject }

object.js, line 348

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

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

object.js, line 308

Sets a parsed option.

Name Type Description
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:
Type Description
ReflectionObject this

toJSON(toJSONOptions){ IOneOf }

oneof.js, line 75

Converts this oneof to a oneof descriptor.

Name Type Description
toJSONOptions IToJSONOptions optional

JSON conversion options
Returns:
Type Description
IOneOf Oneof descriptor

inherited toString(){ string }

object.js, line 359

Converts this instance to its string representation.

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

OneOf.d(fieldNames){ OneOfDecorator }

oneof.js, line 211

OneOf decorator (TypeScript).

Name Type Description
fieldNames string repeatable

Field names
Deprecated
  • Legacy TypeScript decorator support. Will be removed in a future release.
Returns:
Type Description
OneOfDecorator Decorator function

OneOf.fromJSON(name, json){ OneOf }

oneof.js, line 66

Constructs a oneof from a oneof descriptor.

Name Type Description
name string

Oneof name
json IOneOf

Oneof descriptor
Throws:
Type Description
TypeError

If arguments are invalid
Returns:
Type Description
OneOf Created oneof