Class: OneOf

Extends

• ReflectionObject

Members

comment { string | null }

oneof.js, line 49

Comment for this field.

fieldsArray readonly{ Field[] }

oneof.js, line 43

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

filename { string | null }

object.js, line 103

Defining file name.

fullName readonly{ string }

object.js, line 123

Full name including leading dot.

isProto3Optional readonly{ boolean }

oneof.js, line 175

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 }

object.js, line 50

Unique name within its namespace.

oneof { string[] }

oneof.js, line 36

Field names that belong to this oneof.

options { Object<string, *> | undefined }

object.js, line 38

Options.

parent { Namespace | null }

object.js, line 85

Parent namespace.

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

object.js, line 44

Parsed Options.

resolved { boolean }

object.js, line 91

Whether already resolved or not.

root readonly{ Root }

object.js, line 108

Reference to the root namespace.

Methods

add(field)→{ OneOf }

oneof.js, line 104

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

Parameters:

field

Field

Field to add

Returns:

OneOf

this

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 }

oneof.js, line 150

Called when this object is added to a parent.

Parameters:

parent

ReflectionObject

Parent added to

Returns:

undefined

inherited onRemove(parent)→{ undefined }

oneof.js, line 168

Called when this object is removed from a parent.

Parameters:

parent

ReflectionObject

Parent removed from

Returns:

undefined

remove(field)→{ OneOf }

oneof.js, line 124

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

Parameters:

field

Field

Field to remove

Returns:

OneOf

this

inherited resolve()→{ ReflectionObject }

object.js, line 182

Resolves this objects type references.

Returns:

ReflectionObject

this

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

object.js, line 285

Sets an option.

Parameters:

name	string	Option name
value	*	Option value
ifNotSet	boolean | undefined	optional Sets the option only if it isn't currently set

Returns:

ReflectionObject

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

toJSON(toJSONOptions)→{ IOneOf }

oneof.js, line 76

Converts this oneof to a oneof descriptor.

Parameters:

toJSONOptions

IToJSONOptions

optional JSON conversion options

Returns:

IOneOf

Oneof descriptor

inherited toString()→{ string }

object.js, line 358

Converts this instance to its string representation.

Returns:

string

Class name[, space, full name]

OneOf.d(fieldNames)→{ OneOfDecorator }

oneof.js, line 212

OneOf decorator (TypeScript).

Parameters:

fieldNames

string

repeatable Field names

Deprecated:

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

Returns:

OneOfDecorator

Decorator function

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

oneof.js, line 67

Constructs a oneof from a oneof descriptor.

Parameters:

name	string	Oneof name
json	IOneOf	Oneof descriptor

Throws:

TypeError

If arguments are invalid

Returns:

OneOf

Created oneof