Class: OneOf

Extends

• ReflectionObject

Members

comment { string | null }

Comment text, if any.

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.

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.

resolved { boolean }

Whether already resolved or not.

root readonly{ Root }

Reference to the root namespace.

Methods

OneOf.d(fieldNames){ OneOfDecorator }

src/oneof.js, line 180

OneOf decorator (TypeScript).

Name	Type	Description
fieldNames	string	repeatable Field names

Returns:

Type	Description
OneOfDecorator	Decorator function

OneOf.fromJSON(name, json){ OneOf }

src/oneof.js, line 59

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

add(field){ OneOf }

src/oneof.js, line 93

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){ * }

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

remove(field){ OneOf }

src/oneof.js, line 113

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 }

src/object.js, line 140

Resolves this objects type references.

Returns:

Type	Description
ReflectionObject	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(){ IOneOf }

src/oneof.js, line 67

Converts this oneof to a oneof descriptor.

Returns:

Type	Description
IOneOf	Oneof 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]