Class: Enum

ProtoBuf.Reflect. Enum

new Enum(buildernon-null, parentnon-null, name, optionsopt, syntaxnullable)

Constructs a new Enum.

Parameters:
Name Type Attributes Description
builder ProtoBuf.Builder

Builder reference
parent ProtoBuf.Reflect.T

Parent Reflect object
name string

Enum name
options Object.<string, *> <optional>

Enum options
syntax string <nullable>

The syntax level (e.g., proto3)
Source:

Extends

Classes

Value

Members

(non-null) builder :ProtoBuf.Builder

Builder reference.

Type:
Inherited From:
Source:

(non-null) children :Array.<ProtoBuf.Reflect.T>

Children inside the namespace.

Type:
Inherited From:
Source:

className :string

Fully qualified class name

Type:
  • string
Overrides:
Source:

name :string

Object name in namespace.

Type:
  • string
Inherited From:
Source:

object :Object.<string, number>|null

Runtime enum object.

Type:
  • Object.<string, number> | null
Source:

(non-null) options :Object.<string, *>

Options.

Type:
  • Object.<string, *>
Inherited From:
Source:

(nullable) parent :ProtoBuf.Reflect.T

Parent object.

Type:
Inherited From:
Source:

(non-null) syntax :string

Syntax level (e.g., proto2 or proto3).

Type:
  • string
Inherited From:
Source:

Methods

(static) getName(enmnon-null, value) → (nullable) {string}

Gets the string name of an enum value.

Parameters:
Name Type Description
enm ProtoBuf.Builder.Enum

Runtime enum
value number

Enum value
Source:
Returns:

Name or null if not present

Type
string

addChild(child)

Adds a child to the namespace.

Parameters:
Name Type Description
child ProtoBuf.Reflect.T

Child
Inherited From:
Source:
Throws:

If the child cannot be added (duplicate)

Type
Error

build(rebuild) → (non-null) {Object.<string, number>}

Builds this enum and returns the runtime counterpart.

Parameters:
Name Type Description
rebuild boolean

Whether to rebuild or not, defaults to false
Overrides:
Source:
Returns:
Type
Object.<string, number>

buildOpt() → {Object.<string, *>}

Builds the namespace's '$options' property.

Inherited From:
Source:
Returns:
Type
Object.<string, *>

fqn() → {string}

Returns the fully qualified name of this object.

Inherited From:
Source:
Returns:

Fully qualified name as of ".PATH.TO.THIS"

Type
string

getChild(nameOrId) → (nullable) {ProtoBuf.Reflect.T}

Gets a child by its name or id.

Parameters:
Name Type Description
nameOrId string | number

Child name or id
Inherited From:
Source:
Returns:

The child or null if not found

Type
ProtoBuf.Reflect.T

getChildren(typeopt) → {Array.<ProtoBuf.Reflect.T>}

Returns an array of the namespace's children.

Parameters:
Name Type Attributes Description
type ProtoBuf.Reflect.T <optional>

Filter type (returns instances of this type only). Defaults to null (all children).
Inherited From:
Source:
Returns:
Type
Array.<ProtoBuf.Reflect.T>

getOption(nameopt) → {*|Object.<string, *>}

Gets the value assigned to the option with the specified name.

Parameters:
Name Type Attributes Description
name string <optional>

Returns the option value if specified, otherwise all options are returned.
Inherited From:
Source:
Returns:

null} Option value or NULL if there is no such option

Type
* | Object.<string, *>

qn(tnon-null) → {string}

Determines the shortest qualified name of the specified type, if any, relative to this namespace.

Parameters:
Name Type Description
t ProtoBuf.Reflect.T

Reflection type
Inherited From:
Source:
Returns:

The shortest qualified name or, if there is none, the fqn

Type
string

resolve(qn, excludeNonNamespaceopt) → (nullable) {ProtoBuf.Reflect.Namespace}

Resolves a reflect object inside of this namespace.

Parameters:
Name Type Attributes Description
qn string | !Array.<string>

Qualified name to resolve
excludeNonNamespace boolean <optional>

Excludes non-namespace types, defaults to false
Inherited From:
Source:
Returns:

The resolved type or null if not found

Type
ProtoBuf.Reflect.Namespace

toString(includeClassopt)

Returns a string representation of this Reflect object (its fully qualified name).

Parameters:
Name Type Attributes Description
includeClass boolean <optional>

Set to true to include the class name. Defaults to false.
Inherited From:
Source:
Returns:

String representation