protobuf.js

API documentation

Class: NamespaceBase

NamespaceBase

Base class of all reflection objects containing nested objects. This is not an actual class but here for the sake of having consistent type definitions.

abstractnew NamespaceBase(name, options)

namespace.js, line 101

Not an actual constructor. Use Namespace instead.

Parameters:
name string

Namespace name
options Object.<string, *> optional

Declared options
See:

Extends

Members

comment { string | null }

object.js, line 97

Comment text, if any.

filename { string | null }

object.js, line 103

Defining file name.

fullName readonly{ string }

object.js, line 123

Full name including leading dot.

name { string }

object.js, line 50

Unique name within its namespace.

nested { Object<string, ReflectionObject> | undefined }

namespace.js, line 108

Nested objects by name.

nestedArray readonly{ ReflectionObject[] }

namespace.js, line 153

Nested objects of this namespace as an array for iteration.

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(object){ Namespace }

namespace.js, line 259

Adds a nested object to this namespace.

Parameters:
object ReflectionObject

Nested object to add
Throws:
TypeError

If arguments are invalid
Error

If there is already a nested object with this name
Returns:
Namespace this

addJSON(nestedJson, depth){ Namespace }

namespace.js, line 202

Adds nested objects to this namespace from nested object descriptors.

Parameters:
nestedJson Object.<string, AnyNestedObject>

Any nested object descriptors
depth number optional

Current nesting depth, defaults to 0
Returns:
Namespace this

define(path, json){ Namespace }

namespace.js, line 338

Defines additial namespaces within this one if not yet existing.

Parameters:
path string | Array.<string>

Path to create
json * optional

Nested types to create from JSON
Returns:
Namespace Pointer to the last namespace created or this if path is empty

get(name){ ReflectionObject | null }

namespace.js, line 233

Gets the nested object of the specified name.

Parameters:
name string

Nested object name
Returns:
ReflectionObject | null The reflection object or null if it doesn't exist

getEnum(name){ Object<string, number> }

namespace.js, line 246

Gets the values of the nested enum of the specified name.
This methods differs from get in that it returns an enum's values directly and throws instead of returning null.

Parameters:
name string

Nested enum name
Throws:
Error

If there is no such enum
Returns:
Object.<string, number> Enum values

inherited getOption(name){ * }

object.js, line 272

Gets an option value.

Parameters:
name string

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

lookup(path, filterTypes, parentAlreadyChecked){ ReflectionObject | null }

namespace.js, line 408

Recursively looks up the reflection object matching the specified path in the scope of this namespace.

Parameters:
path string | Array.<string>

Path to look up
filterTypes * | Array.<*>

Filter types, any combination of the constructors of protobuf.Type, protobuf.Enum, protobuf.Service etc.
parentAlreadyChecked boolean false optional

If known, whether the parent has already been checked
Returns:
ReflectionObject | null Looked up object or null if none could be found

lookup(path, parentAlreadyChecked){ ReflectionObject | null }

namespace.js, line 493

Looks up the reflection object at the specified path, relative to this namespace.

Parameters:
path string | Array.<string>

Path to look up
parentAlreadyChecked boolean false optional

Whether the parent has already been checked
Returns:
ReflectionObject | null Looked up object or null if none could be found

lookupEnum(path){ Enum }

namespace.js, line 525

Looks up the values of the enum at the specified path, relative to this namespace.
Besides its signature, this methods differs from lookup in that it throws instead of returning null.

Parameters:
path string | Array.<string>

Path to look up
Throws:
Error

If path does not point to an enum
Returns:
Enum Looked up enum

lookupService(path){ Service }

namespace.js, line 553

Looks up the service at the specified path, relative to this namespace.
Besides its signature, this methods differs from lookup in that it throws instead of returning null.

Parameters:
path string | Array.<string>

Path to look up
Throws:
Error

If path does not point to a service
Returns:
Service Looked up service

lookupType(path){ Type }

namespace.js, line 511

Looks up the type at the specified path, relative to this namespace.
Besides its signature, this methods differs from lookup in that it throws instead of returning null.

Parameters:
path string | Array.<string>

Path to look up
Throws:
Error

If path does not point to a type
Returns:
Type Looked up type

lookupTypeOrEnum(path){ Type }

namespace.js, line 539

Looks up the type or enum at the specified path, relative to this namespace.
Besides its signature, this methods differs from lookup in that it throws instead of returning null.

Parameters:
path string | Array.<string>

Path to look up
Throws:
Error

If path does not point to a type or enum
Returns:
Type Looked up type or enum

inherited onAdd(parent){ undefined }

object.js, line 155

Called when this object is added to a parent.

Parameters:
parent ReflectionObject

Parent added to
Returns:
undefined

inherited onRemove(parent){ undefined }

object.js, line 170

Called when this object is removed from a parent.

Parameters:
parent ReflectionObject

Parent removed from
Returns:
undefined

remove(object){ Namespace }

namespace.js, line 317

Removes a nested object from this namespace.

Parameters:
object ReflectionObject

Nested object to remove
Throws:
TypeError

If arguments are invalid
Error

If object is not a member of this namespace
Returns:
Namespace this

inherited resolve(){ ReflectionObject }

object.js, line 182

Resolves this objects type references.

Returns:
ReflectionObject this

resolveAll(){ Namespace }

namespace.js, line 368

Resolves this namespace's and all its nested objects' type references. Useful to validate a reflection tree, but comes at a cost.

Returns:
Namespace 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){ INamespace }

namespace.js, line 189

Converts this namespace to a namespace descriptor.

Parameters:
toJSONOptions IToJSONOptions optional

JSON conversion options
Returns:
INamespace Namespace descriptor

inherited toString(){ string }

object.js, line 358

Converts this instance to its string representation.

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