protobuf.js

https://protobufjs.github.io/protobuf.js/
Admin
A standalone JavaScript implementation of Protocol Buffers with TypeScript support for Node.js and...
Tokens:20,056
Snippets:235
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install protobuf.js package

Source: https://protobufjs.github.io/protobuf.js/index.html

Install the core protobuf.js library via npm.

```bash
npm install protobufjs
```

--------------------------------

### Install protobuf.js CLI

Source: https://protobufjs.github.io/protobuf.js/index.html

Install the command line utility for generating reflection bundles and static code.

```bash
npm install --save-dev protobufjs-cli
```

--------------------------------

### Clone and Install Dependencies

Source: https://protobufjs.github.io/protobuf.js/index.html

Commands to clone the repository and install necessary dependencies for the library and CLI.

```bash
git clone https://github.com/protobufjs/protobuf.js
cd protobuf.js
npm install
npm --prefix cli install
```

--------------------------------

### Run performance benchmarks

Source: https://protobufjs.github.io/protobuf.js/index.html

Commands to install dependencies and execute the benchmark suite on local hardware.

```bash
npm --prefix bench install
npm run bench
```

--------------------------------

### Define a Protobuf Schema

Source: https://protobufjs.github.io/protobuf.js/index.html

Example schema definition using proto3 syntax.

```protobuf
syntax = "proto3";

package awesomepackage;

message AwesomeMessage {
  string awesome_field = 1;
}
```

--------------------------------

### Define Oneof in Proto

Source: https://protobufjs.github.io/protobuf.js/index.html

Example of a oneof definition in a .proto file.

```protobuf
message Profile {
  oneof contact {
    string email = 1;
    string phone = 2;
  }
}
```

--------------------------------

### raw(start, end)

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Returns raw bytes from the backing buffer without advancing the reader position.

```APIDOC
## raw(start, end)

### Description
Returns a slice of raw bytes from the backing buffer without modifying the current reader position.

### Parameters
- **start** (number) - Required - The start offset.
- **end** (number) - Required - The end offset.

### Returns
- **Buffer** - The raw bytes extracted.
```

--------------------------------

### util.utf8.read(buffer, start, end)

Source: https://protobufjs.github.io/protobuf.js/util.utf8.html

Reads UTF8 bytes from a buffer and converts them into a string.

```APIDOC
## util.utf8.read(buffer, start, end)

### Description
Reads UTF8 bytes as a string.

### Parameters
- **buffer** (Uint8Array) - Source buffer.
- **start** (number) - Source start index.
- **end** (number) - Source end index.

### Returns
- **string** - The string read from the buffer.
```

--------------------------------

### util.base64.encode(buffer, start, end)

Source: https://protobufjs.github.io/protobuf.js/util.base64.html

Encodes a portion of a buffer into a base64 encoded string.

```APIDOC
## util.base64.encode(buffer, start, end)

### Description
Encodes a buffer to a base64 encoded string.

### Parameters
- **buffer** (Uint8Array) - Source buffer
- **start** (number) - Source start
- **end** (number) - Source end

### Returns
- **string** - Base64 encoded string
```

--------------------------------

### getTypeUrl(prefix)

Source: https://protobufjs.github.io/protobuf.js/Type.html

Gets the type url for this type.

```APIDOC
## getTypeUrl(prefix)

### Description
Gets the type url for this type.

### Parameters
- **prefix** (string) - Optional - Custom type url prefix, defaults to "type.googleapis.com"

### Returns
- **string** - The type url
```

--------------------------------

### util.utf8.readStrict(buffer, start, end)

Source: https://protobufjs.github.io/protobuf.js/util.utf8.html

Reads UTF8 bytes from a buffer and converts them into a string, rejecting invalid UTF8 sequences.

```APIDOC
## util.utf8.readStrict(buffer, start, end)

### Description
Reads UTF8 bytes as a string, rejecting invalid UTF8.

### Parameters
- **buffer** (Uint8Array) - Source buffer.
- **start** (number) - Source start index.
- **end** (number) - Source end index.

### Returns
- **string** - The string read from the buffer.
```

--------------------------------

### Build Project

Source: https://protobufjs.github.io/protobuf.js/index.html

Command to build development and production versions with source maps to the dist directory.

```bash
npm run build
```

--------------------------------

### new Service(name, options)

Source: https://protobufjs.github.io/protobuf.js/Service.html

Constructs a new service instance.

```APIDOC
## new Service(name, options)

### Description
Constructs a new service instance.

### Parameters
- **name** (string) - Required - Service name
- **options** (Object<string, *>) - Optional - Service options

### Throws
- **TypeError** - If arguments are invalid
```

--------------------------------

### Use Static Modules

Source: https://protobufjs.github.io/protobuf.js/index.html

Import the generated static module and create message instances.

```javascript
import { awesomepackage } from "./awesome.js";

const message = awesomepackage.AwesomeMessage.create({ awesomeField: "hello" });
```

--------------------------------

### Run Tests

Source: https://protobufjs.github.io/protobuf.js/index.html

Command to execute the test suite.

```bash
npm test
```

--------------------------------

### protobuf.load(filename, root, callback)

Source: https://protobufjs.github.io/protobuf.js/global.html

Loads one or multiple .proto or preprocessed .json files into a common root namespace.

```APIDOC
## protobuf.load(filename, root, callback)

### Description
Loads one or multiple .proto or preprocessed .json files into a common root namespace and calls the callback.

### Parameters
- **filename** (string | Array<string>) - Required - One or multiple files to load
- **root** (Root) - Optional - Root namespace, defaults to create a new one if omitted
- **callback** (LoadCallback) - Required - Callback function

### Returns
- **undefined**
```

--------------------------------

### Generate Reflection Bundles

Source: https://protobufjs.github.io/protobuf.js/index.html

Create a JSON bundle from one or more .proto files for use with the reflection runtime.

```bash
npx pbjs -t json -o awesome.json awesome1.proto awesome2.proto ...
```

--------------------------------

### new rpc.Service(rpcImpl, requestDelimited, responseDelimited)

Source: https://protobufjs.github.io/protobuf.js/rpc.Service.html

Constructs a new RPC service instance.

```APIDOC
## new rpc.Service(rpcImpl, requestDelimited, responseDelimited)

### Description
Constructs a new RPC service instance.

### Parameters
- **rpcImpl** (RPCImpl) - Required - RPC implementation
- **requestDelimited** (boolean) - Optional - Whether requests are length-delimited (default: false)
- **responseDelimited** (boolean) - Optional - Whether responses are length-delimited (default: false)
```

--------------------------------

### protobuf.loadSync(filename, root)

Source: https://protobufjs.github.io/protobuf.js/global.html

Synchronously loads one or multiple .proto or preprocessed .json files into a common root namespace.

```APIDOC
## protobuf.loadSync(filename, root)

### Description
Synchronously loads one or multiple .proto or preprocessed .json files into a common root namespace (node only).

### Parameters
- **filename** (string | Array<string>) - Required - One or multiple files to load
- **root** (Root) - Optional - Root namespace, defaults to create a new one if omitted

### Returns
- **Root** - Root namespace

### Throws
- **Error** - If synchronous fetching is not supported or if a file's syntax is invalid
```

--------------------------------

### Integrating with @grpc/grpc-js

Source: https://protobufjs.github.io/protobuf.js/index.html

Demonstrates using an rpcImpl to bridge protobuf.js services with gRPC clients.

```javascript
const grpc = require('@grpc/grpc-js');

const Client = grpc.makeGenericClientConstructor({});
const client = new Client(serverAddress, grpc.credentials.createInsecure());

const rpcImpl = (method, requestData, callback) =>
  client.makeUnaryRequest(method.path, (data) => data, (data) => data, requestData, callback);

const greeter = root.lookupService("example.Greeter").create(rpcImpl);
const reply = await greeter.sayHello({ name: "world" });
```

--------------------------------

### IParseOptions

Source: https://protobufjs.github.io/protobuf.js/IParseOptions.html

Configuration options for the protobuf parser.

```APIDOC
## IParseOptions

### Description
Options modifying the behavior of the parser.

### Properties
- **keepCase** (boolean) - Optional - Default: false. Keeps field casing instead of converting to camel case.
- **alternateCommentMode** (boolean) - Optional - Default: false. Recognize double-slash comments in addition to doc-block comments.
- **preferTrailingComment** (boolean) - Optional - Default: false. Use trailing comment when both leading comment and trailing comment exist.
```

--------------------------------

### create(rpcImpl, requestDelimited, responseDelimited)

Source: https://protobufjs.github.io/protobuf.js/Service.html

Creates a runtime service using the specified rpc implementation.

```APIDOC
## create(rpcImpl, requestDelimited, responseDelimited)

### Description
Creates a runtime service using the specified rpc implementation. Useful where requests and/or responses are streamed.

### Parameters
- **rpcImpl** (RPCImpl) - Required - RPC implementation
- **requestDelimited** (boolean) - Optional - Whether requests are length-delimited (default: false)
- **responseDelimited** (boolean) - Optional - Whether responses are length-delimited (default: false)

### Returns
- **rpc.Service** - The created RPC service
```

--------------------------------

### load(filename, options)

Source: https://protobufjs.github.io/protobuf.js/Root.html

Loads one or multiple .proto or preprocessed .json files into this root namespace.

```APIDOC
## load(filename, options)

### Description
Loads one or multiple .proto or preprocessed .json files into this root namespace and returns a promise.

### Parameters
- **filename** (string | Array<string>) - Required - Names of one or multiple files to load
- **options** (IParseOptions) - Optional - Parse options. Defaults to parse.defaults when omitted.

### Returns
- **Promise<Root>** - A promise that resolves to the Root namespace.
```

--------------------------------

### Root.fromJSON(json, root, depth)

Source: https://protobufjs.github.io/protobuf.js/Root.html

Loads a namespace descriptor into a root namespace.

```APIDOC
## Root.fromJSON(json, root, depth)

### Description
Loads a namespace descriptor into a root namespace.

### Parameters
- **json** (INamespace) - Required - Namespace descriptor
- **root** (Root) - Optional - Root namespace, defaults to create a new one if omitted
- **depth** (number) - Optional - Current nesting depth, defaults to 0

### Returns
- **Root** - Root namespace
```

--------------------------------

### on(evt, fn, ctx)

Source: https://protobufjs.github.io/protobuf.js/util.EventEmitter.html

Registers an event listener.

```APIDOC
## on(evt, fn, ctx)

### Description
Registers an event listener.

### Parameters
- **evt** (string) - Required - Event name
- **fn** (EventEmitterListener) - Required - Listener
- **ctx** (*) - Optional - Listener context

### Returns
- **this** (this) - The event emitter instance
```

--------------------------------

### loadSync(filename, options)

Source: https://protobufjs.github.io/protobuf.js/Root.html

Synchronously loads one or multiple .proto or preprocessed .json files into this root namespace (node only).

```APIDOC
## loadSync(filename, options)

### Description
Synchronously loads one or multiple .proto or preprocessed .json files into this root namespace (node only).

### Parameters
- **filename** (string | Array<string>) - Required - Names of one or multiple files to load
- **options** (IParseOptions) - Optional - Parse options. Defaults to parse.defaults when omitted.

### Throws
- **Error** - If synchronous fetching is not supported or if a file's syntax is invalid.

### Returns
- **Root** - The Root namespace.
```

--------------------------------

### util.fetch(path, options)

Source: https://protobufjs.github.io/protobuf.js/util.html

Fetches the contents of a file and returns a Promise.

```APIDOC
## util.fetch(path, options)

### Description
Fetches the contents of a file.

### Parameters
- **path** (string) - Required - File path or url
- **options** (IFetchOptions) - Optional - Fetch options

### Returns
- **Promise<(string|Uint8Array)>** - Promise
```

--------------------------------

### Load a Schema

Source: https://protobufjs.github.io/protobuf.js/index.html

Asynchronous loading of a .proto file and looking up a message type.

```javascript
const protobuf = require("protobufjs");

const root = await protobuf.load("awesome.proto");
const AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage");
```

--------------------------------

### parse(source, root, options)

Source: https://protobufjs.github.io/protobuf.js/global.html

Parses the given .proto source and returns an object with the parsed contents.

```APIDOC
## parse(source, root, options)

### Description
Pareses the given .proto source and returns an object with the parsed contents.

### Parameters
- **source** (string) - Required - Source contents
- **root** (Root) - Required - Root to populate
- **options** (IParseOptions) - Optional - Parse options. Defaults to parse.defaults when omitted.

### Returns
- **IParserResult** - Parser result
```

--------------------------------

### util.fetch(filename, options, callback)

Source: https://protobufjs.github.io/protobuf.js/util.html

Fetches the contents of a file using a callback.

```APIDOC
## util.fetch(filename, options, callback)

### Description
Fetches the contents of a file.

### Parameters
- **filename** (string) - Required - File path or url
- **options** (IFetchOptions) - Required - Fetch options
- **callback** (FetchCallback) - Required - Callback function
```

--------------------------------

### Writer Constructor

Source: https://protobufjs.github.io/protobuf.js/Writer.html

Constructs a new Writer instance.

```APIDOC
## new Writer()

### Description
Constructs a new writer instance for wire format serialization.
```

--------------------------------

### Service.fromJSON(name, json, depth)

Source: https://protobufjs.github.io/protobuf.js/Service.html

Constructs a service from a service descriptor.

```APIDOC
## Service.fromJSON(name, json, depth)

### Description
Constructs a service from a service descriptor.

### Parameters
- **name** (string) - Required - Service name
- **json** (IService) - Required - Service descriptor
- **depth** (number) - Optional - Current nesting depth, defaults to 0

### Throws
- **TypeError** - If arguments are invalid

### Returns
- **Service** - Created service
```

--------------------------------

### Generate Static Modules

Source: https://protobufjs.github.io/protobuf.js/index.html

Use the CLI to generate static JavaScript code and TypeScript declarations from a .proto file.

```bash
npx pbjs -t static-module -w esm -o awesome.js --dts awesome.proto
```

--------------------------------

### Load Reflection Bundles

Source: https://protobufjs.github.io/protobuf.js/index.html

Load a JSON bundle and look up types using the reflection API.

```javascript
const bundle = require("./awesome.json");

const root = protobuf.Root.fromJSON(bundle);
const AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage");
```

--------------------------------

### Writer.create()

Source: https://protobufjs.github.io/protobuf.js/Writer.html

Creates a new instance of a Writer or BufferWriter.

```APIDOC
## Writer.create()

### Description
Creates a new writer instance. Returns a BufferWriter if Buffers are supported, otherwise returns a Writer.

### Returns
- **Writer | BufferWriter** - The created writer instance.
```

--------------------------------

### new BufferWriter()

Source: https://protobufjs.github.io/protobuf.js/BufferWriter.html

Constructs a new BufferWriter instance for writing data to a buffer.

```APIDOC
## new BufferWriter()

### Description
Constructs a new buffer writer instance for serializing data into Node buffers.

### Returns
- **BufferWriter** - A new instance of the BufferWriter class.
```

--------------------------------

### RPCImpl(method, requestData, callback)

Source: https://protobufjs.github.io/protobuf.js/global.html

RPC implementation interface used by Service#create to perform network-level requests.

```APIDOC
## RPCImpl(method, requestData, callback)

### Description
RPC implementation passed to Service#create performing a service request on network level, i.e. by utilizing http requests or websockets.

### Parameters
- **method** (rpc.ServiceMethod<Message<{}>, Message<{}>>) - Required - Reflected or static method being called
- **requestData** (Uint8Array) - Required - Request data
- **callback** (RPCImplCallback) - Required - Callback function

### Example
```javascript
function rpcImpl(method, requestData, callback) {
    if (protobuf.util.lcFirst(method.name) !== "myMethod") // compatible with static code
        throw Error("no such method");
    asynchronouslyObtainAResponse(requestData, function(err, responseData) {
        callback(err, responseData);
    });
}
```
```

--------------------------------

### Constructing schemas programmatically

Source: https://protobufjs.github.io/protobuf.js/index.html

Builds message types and namespaces using the reflection API.

```javascript
const AwesomeMessage = new protobuf.Type("AwesomeMessage")
  .add(new protobuf.Field("awesomeField", 1, "string"));

const root = new protobuf.Root()
  .define("awesomepackage")
  .add(AwesomeMessage);
```

--------------------------------

### Method.fromJSON(name, json)

Source: https://protobufjs.github.io/protobuf.js/Method.html

Constructs a method from a method descriptor.

```APIDOC
## Method.fromJSON(name, json)

### Description
Constructs a method from a method descriptor.

### Parameters
- **name** (string) - Required - Method name
- **json** (IMethod) - Required - Method descriptor

### Returns
- **Method** - Created method

### Throws
- **TypeError** - If arguments are invalid
```

--------------------------------

### Implement RPC Service Request

Source: https://protobufjs.github.io/protobuf.js/global.html

Define a custom RPC implementation for Service#create to handle network-level requests like HTTP or WebSockets.

```javascript
function rpcImpl(method, requestData, callback) {
    if (protobuf.util.lcFirst(method.name) !== "myMethod") // compatible with static code
        throw Error("no such method");
    asynchronouslyObtainAResponse(requestData, function(err, responseData) {
        callback(err, responseData);
    });
}
```

--------------------------------

### Use JSON Modules

Source: https://protobufjs.github.io/protobuf.js/index.html

Import and use types from a generated JSON module.

```javascript
import { awesomepackage } from "./awesome.js";

const AwesomeMessage = awesomepackage.AwesomeMessage;
```

--------------------------------

### Encode and Decode Messages

Source: https://protobufjs.github.io/protobuf.js/index.html

Creating a message instance, encoding it to a buffer, and decoding it back.

```javascript
const payload = { awesomeField: "hello" };

// Optionally create a message instance from already valid data
const message = AwesomeMessage.create(payload);

const encoded = AwesomeMessage.encode(message).finish();
const decoded = AwesomeMessage.decode(encoded);
```

--------------------------------

### tokenize(source, alternateCommentMode)

Source: https://protobufjs.github.io/protobuf.js/global.html

Tokenizes the given .proto source and returns an object with useful utility functions.

```APIDOC
## tokenize(source, alternateCommentMode)

### Description
Tokenizes the given .proto source and returns an object with useful utility functions.

### Parameters
- **source** (string) - Required - Source contents
- **alternateCommentMode** (boolean) - Required - Whether we should activate alternate comment parsing mode.

### Returns
- **ITokenizerHandle** - Tokenizer handle
```

--------------------------------

### new util.EventEmitter()

Source: https://protobufjs.github.io/protobuf.js/util.EventEmitter.html

Constructs a new event emitter instance.

```APIDOC
## new util.EventEmitter()

### Description
Constructs a new event emitter instance.
```

--------------------------------

### util.asPromise(fn, ctx, params)

Source: https://protobufjs.github.io/protobuf.js/util.html

Converts a node-style callback function into a Promise.

```APIDOC
## util.asPromise(fn, ctx, params)

### Description
Returns a promise from a node-style callback function.

### Parameters
- **fn** (asPromiseCallback) - Required - Function to call
- **ctx** (*) - Required - Function context
- **params** (*) - Required - Function arguments

### Returns
- **Promise<*>** - Promisified function
```

--------------------------------

### new BufferReader(buffer)

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Constructs a new BufferReader instance to read from the provided buffer.

```APIDOC
## new BufferReader(buffer)

### Description
Constructs a new buffer reader instance for reading data from a Node.js buffer.

### Parameters
- **buffer** (Buffer) - Required - The buffer to read from.
```

--------------------------------

### util.pool(alloc, slice, size)

Source: https://protobufjs.github.io/protobuf.js/util.html

A general purpose buffer pool.

```APIDOC
## util.pool(alloc, slice, size)

### Description
A general purpose buffer pool.

### Parameters
- **alloc** (PoolAllocator) - Required - Allocator
- **slice** (PoolSlicer) - Required - Slicer
- **size** (number) - Optional - Slab size (default: 8192)

### Returns
- **PoolAllocator** - Pooled allocator
```

--------------------------------

### Providing Common Type Definitions

Source: https://protobufjs.github.io/protobuf.js/global.html

Manually register custom or standard Google protobuf type definitions into the library.

```javascript
// manually provides descriptor.proto (assumes google/protobuf/ namespace and .proto extension)
protobuf.common("descriptor", descriptorJson);

// manually provides a custom definition (uses my.foo namespace)
protobuf.common("my/foo/bar.proto", myFooBarJson);
```

--------------------------------

### util.path.resolve(originPath, includePath, alreadyNormalized)

Source: https://protobufjs.github.io/protobuf.js/util.path.html

Resolves the specified include path against the specified origin path.

```APIDOC
## util.path.resolve(originPath, includePath, alreadyNormalized)

### Description
Resolves the specified include path against the specified origin path.

### Parameters
- **originPath** (string) - Required - Path to the origin file
- **includePath** (string) - Required - Include path relative to origin path
- **alreadyNormalized** (boolean) - Optional - true if both paths are already known to be normalized

### Returns
- **string** - Path to the include file
```

--------------------------------

### lookupService(path)

Source: https://protobufjs.github.io/protobuf.js/NamespaceBase.html

Looks up the service at the specified path, relative to this namespace. Throws an error if the path does not point to a service.

```APIDOC
## lookupService(path)

### Description
Looks up the service at the specified path, relative to this namespace. This method throws an error if the path does not point to a service.

### Parameters
- **path** (string | Array<string>) - Required - Path to look up

### Returns
- **Service** - Looked up service

### Throws
- **Error** - If path does not point to a service
```

--------------------------------

### IToJSONOptions

Source: https://protobufjs.github.io/protobuf.js/IToJSONOptions.html

Configuration interface for JSON serialization options.

```APIDOC
## IToJSONOptions

### Description
Options modifying the behavior of JSON serialization.

### Properties
- **keepComments** (boolean) - Optional - Defaults to false. If set to true, serializes comments.
```

--------------------------------

### util.path.normalize

Source: https://protobufjs.github.io/protobuf.js/util.path.html

Normalizes a path string.

```APIDOC
## util.path.normalize

### Description
Normalizes the provided path string, resolving '..' and '.' segments.

### Parameters
- **path** (string) - Required - The path to normalize.
```

--------------------------------

### Convert Plain Objects

Source: https://protobufjs.github.io/protobuf.js/index.html

Using fromObject and toObject to handle interoperability between JavaScript objects and protobuf messages.

```javascript
const message = AwesomeMessage.fromObject({ awesomeField: 42 });
const object = AwesomeMessage.toObject(message, {
  longs: String,
  enums: String,
  bytes: String
});
```

--------------------------------

### Namespace.fromJSON

Source: https://protobufjs.github.io/protobuf.js/Namespace.html

Constructs a namespace instance from a JSON object.

```APIDOC
## Namespace.fromJSON(name, json, depth)

### Description
Constructs a namespace from JSON.

### Parameters
- **name** (string) - Required - Namespace name.
- **json** (Object<string, *>) - Required - JSON object.
- **depth** (number) - Optional - Current nesting depth, defaults to 0.

### Throws
- **TypeError** - If arguments are invalid.

### Returns
- **Namespace** - Created namespace.
```

--------------------------------

### util.newBuffer(sizeOrArray)

Source: https://protobufjs.github.io/protobuf.js/util.html

Creates a new buffer of whatever type supported by the environment.

```APIDOC
## util.newBuffer(sizeOrArray)

### Description
Creates a new buffer of whatever type supported by the environment.

### Parameters
- **sizeOrArray** (number | Array<number>) - Optional - Buffer size or number array (default: 0)

### Returns
- **Uint8Array | Buffer** - Buffer
```

--------------------------------

### Reader.create(buffer)

Source: https://protobufjs.github.io/protobuf.js/Reader.html

Creates a new reader instance using the specified buffer.

```APIDOC
## Reader.create(buffer)

### Description
Creates a new reader using the specified buffer.

### Parameters
- **buffer** (Uint8Array | Buffer) - Required - Buffer to read from

### Returns
- **Reader | BufferReader** - A BufferReader if buffer is a Buffer, otherwise a Reader

### Throws
- **Error** - If buffer is not a valid buffer
```

--------------------------------

### sfixed64()

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Reads zig-zag encoded fixed 64 bits.

```APIDOC
## sfixed64()

### Description
Reads zig-zag encoded fixed 64 bits.

### Returns
- **Long** - Value read
```

--------------------------------

### string(value)

Source: https://protobufjs.github.io/protobuf.js/BufferWriter.html

Writes a string to the buffer.

```APIDOC
## string(value)

### Description
Writes a string.

### Parameters
- **value** (string) - Required - Value to write

### Returns
- **Writer** - Returns the writer instance.
```

--------------------------------

### emit(evt, args)

Source: https://protobufjs.github.io/protobuf.js/util.EventEmitter.html

Emits an event by calling its listeners with the specified arguments.

```APIDOC
## emit(evt, args)

### Description
Emits an event by calling its listeners with the specified arguments.

### Parameters
- **evt** (string) - Required - Event name
- **args** (*) - Required - Repeatable arguments

### Returns
- **this** (this) - The event emitter instance
```

--------------------------------

### new Type(name, options)

Source: https://protobufjs.github.io/protobuf.js/Type.html

Constructs a new reflected message type instance.

```APIDOC
## new Type(name, options)

### Description
Constructs a new reflected message type instance.

### Parameters
- **name** (string) - Required - Message name
- **options** (Object<string, *>) - Optional - Declared options
```

--------------------------------

### util.longFromKey(key, unsigned)

Source: https://protobufjs.github.io/protobuf.js/util.html

Converts a 64 bit key to a long or number if it is an 8 characters long hash string.

```APIDOC
## util.longFromKey(key, unsigned)

### Description
Converts a 64 bit key to a long or number if it is an 8 characters long hash string.

### Parameters
- **key** (string) - Required - Map key
- **unsigned** (boolean) - Optional - Whether unsigned or not (default: false)

### Returns
- **Long | number | string** - Original value
```

--------------------------------

### new util.LongBits(lo, hi)

Source: https://protobufjs.github.io/protobuf.js/util.LongBits.html

Constructs a new LongBits instance from low and high 32-bit unsigned integers.

```APIDOC
## new util.LongBits(lo, hi)

### Description
Constructs a new LongBits instance representing a 64-bit value.

### Parameters
- **lo** (number) - Required - Low 32 bits, unsigned.
- **hi** (number) - Required - High 32 bits, unsigned.
```

--------------------------------

### protobuf.common(name, json)

Source: https://protobufjs.github.io/protobuf.js/global.html

Provides common type definitions, such as Google protobuf types or custom definitions.

```APIDOC
## protobuf.common(name, json)

### Description
Provides common type definitions. Can also be used to provide additional google types or your own custom types.

### Parameters
- **name** (string) - Required - Short name as in google/protobuf/[name].proto or full file name
- **json** (Object<string, *>) - Required - JSON definition within google.protobuf if a short name, otherwise the file's root definition

### Returns
- **undefined**
```

--------------------------------

### lookupService(path)

Source: https://protobufjs.github.io/protobuf.js/Service.html

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

```APIDOC
## lookupService(path)

### Description
Looks up the service at the specified path, relative to this namespace. This method throws an error if the path does not point to a service.

### Parameters
- **path** (string | Array<string>) - Required - Path to look up

### Throws
- **Error** - If path does not point to a service

### Returns
- **Service** - Looked up service
```

--------------------------------

### Implementing RPC services

Source: https://protobufjs.github.io/protobuf.js/index.html

Defines a transport-agnostic rpcImpl function to connect service clients to various network protocols.

```javascript
function myRpcImpl(method, requestData, callback) {
  // method.name
  // method.path
  // method.requestStream?
  // method.responseStream?
  performRequest(requestData, function(err, responseData) {
    callback(err, responseData);
  });
}

const myService = MyService.create(myRpcImpl/*, requestDelimited?, responseDelimited? */);
```

--------------------------------

### Writer.alloc(size)

Source: https://protobufjs.github.io/protobuf.js/Writer.html

Allocates a buffer of the specified size.

```APIDOC
## Writer.alloc(size)

### Description
Allocates a buffer of the specified size.

### Parameters
- **size** (number) - Required - Buffer size

### Returns
- **Uint8Array** - The allocated buffer.
```

--------------------------------

### finish()

Source: https://protobufjs.github.io/protobuf.js/BufferWriter.html

Finalizes the write operation and returns the resulting buffer.

```APIDOC
## finish()

### Description
Finishes the write operation and returns the completed buffer containing the serialized data.

### Returns
- **Buffer** - The finished buffer.
```

--------------------------------

### BufferWriter.alloc(size)

Source: https://protobufjs.github.io/protobuf.js/BufferWriter.html

Allocates a buffer of the specified size.

```APIDOC
## BufferWriter.alloc(size)

### Description
Allocates a buffer of the specified size.

### Parameters
- **size** (number) - Required - Buffer size

### Returns
- **Buffer** - The allocated buffer
```

--------------------------------

### add(name, id, comment, options)

Source: https://protobufjs.github.io/protobuf.js/Enum.html

Adds a value to this enum.

```APIDOC
## add(name, id, comment, options)

### Description
Adds a value to this enum.

### Parameters
- **name** (string) - Required - Value name
- **id** (number) - Required - Value id
- **comment** (string) - Optional - Comment, if any
- **options** (Object<string, *>) - Optional - Options, if any

### Returns
- **Enum** - Returns this instance.
```

--------------------------------

### uint64()

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Reads a varint as an unsigned 64 bit value.

```APIDOC
## uint64()

### Description
Reads a varint as an unsigned 64 bit value.

### Returns
- **Long** - Value read
```

--------------------------------

### Catching a ProtocolError

Source: https://protobufjs.github.io/protobuf.js/util.ProtocolError.html

Demonstrates how to catch a ProtocolError during message decoding and access the partially decoded instance if available.

```javascript
try {
    MyMessage.decode(someBuffer); // throws if required fields are missing
} catch (e) {
    if (e instanceof ProtocolError && e.instance)
        console.log("decoded so far: " + JSON.stringify(e.instance));
}
```

--------------------------------

### util.path.isAbsolute(path)

Source: https://protobufjs.github.io/protobuf.js/util.path.html

Tests if the specified path is absolute.

```APIDOC
## util.path.isAbsolute(path)

### Description
Tests if the specified path is absolute.

### Parameters
- **path** (string) - Required - Path to test

### Returns
- **boolean** - true if path is absolute
```

--------------------------------

### finish(shared)

Source: https://protobufjs.github.io/protobuf.js/Writer.html

Finishes the write operation and returns the resulting buffer.

```APIDOC
## finish(shared)

### Description
Finishes the write operation. Returns a buffer sized to the written data by default.

### Parameters
- **shared** (boolean) - Optional (default: false) - Whether to return a shared view instead of a unique copy

### Returns
- **Uint8Array** - Finished buffer
```

--------------------------------

### TokenizerHandleSkip(expected, optional)

Source: https://protobufjs.github.io/protobuf.js/global.html

Skips the next token in the tokenizer stream.

```APIDOC
## TokenizerHandleSkip(expected, optional)

### Description
Skips the next token.

### Parameters
- **expected** (string) - Required - Expected token
- **optional** (boolean) - Optional - If optional

### Throws
- **Error** - If the token didn't match and is not optional

### Returns
- **boolean** - Whether the token matched
```

--------------------------------

### util.codegen(functionParams, functionName)

Source: https://protobufjs.github.io/protobuf.js/util.html

Begins generating a function for code generation purposes.

```APIDOC
## util.codegen(functionParams, functionName)

### Description
Begins generating a function.

### Parameters
- **functionParams** (Array<string>) - Required - Function parameter names
- **functionName** (string) - Optional - Function name if not anonymous

### Returns
- **Codegen** - Appender that appends code to the function's body
```

--------------------------------

### rpc.Service Methods

Source: https://protobufjs.github.io/protobuf.js/rpc.Service.html

Methods available on the rpc.Service class for managing RPC communication and event handling.

```APIDOC
## rpc.Service Methods

### rpcCall(method, requestCtor, responseCtor, request, callback)
- **Description**: Initiates an RPC call using the service implementation.

### emit(event, ...args)
- **Description**: Emits an event.

### on(event, listener)
- **Description**: Registers an event listener.

### off(event, listener)
- **Description**: Removes an event listener.

### end(callback)
- **Description**: Ends the service connection.
```

--------------------------------

### toJSON(toJSONOptions)

Source: https://protobufjs.github.io/protobuf.js/NamespaceBase.html

Converts this namespace to a namespace descriptor.

```APIDOC
## toJSON(toJSONOptions)

### Description
Converts this namespace to a namespace descriptor.

### Parameters
- **toJSONOptions** (IToJSONOptions) - Optional - JSON conversion options

### Returns
- **INamespace** - Namespace descriptor
```

--------------------------------

### toObject(message, options)

Source: https://protobufjs.github.io/protobuf.js/Type.html

Creates a plain object from a message of this type.

```APIDOC
## toObject(message, options)

### Description
Creates a plain object from a message of this type. Also converts values to other types if specified.

### Parameters
- **message** (Message<{}>) - Required - Message instance
- **options** (IConversionOptions) - Optional - Conversion options

### Returns
- **Object<string, *>** - Plain object
```

--------------------------------

### Field.fromJSON(name, json)

Source: https://protobufjs.github.io/protobuf.js/Field.html

Constructs a field from a field descriptor.

```APIDOC
## Field.fromJSON(name, json)

### Description
Constructs a field from a field descriptor.

### Parameters
- **name** (string) - Required - Field name
- **json** (IField) - Required - Field descriptor

### Returns
- **Field** - Created field

### Throws
- **TypeError** - If arguments are invalid
```

--------------------------------

### resolveAll()

Source: https://protobufjs.github.io/protobuf.js/NamespaceBase.html

Resolves this namespace's and all its nested objects' type references.

```APIDOC
## resolveAll()

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

### Returns
- **Namespace** - Returns 'this'
```

--------------------------------

### util.ucFirst(str)

Source: https://protobufjs.github.io/protobuf.js/util.html

Converts the first character of a string to upper case.

```APIDOC
## util.ucFirst(str)

### Description
Converts the first character of a string to upper case.

### Parameters
- **str** (string) - Required - String to convert

### Returns
- **string** - Converted string
```

--------------------------------

### string()

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Reads a string preceeded by its byte length as a varint.

```APIDOC
## string()

### Description
Reads a string preceeded by its byte length as a varint.

### Returns
- **string** - Value read
```

--------------------------------

### rpcCall(method, requestCtor, responseCtor, request, callback)

Source: https://protobufjs.github.io/protobuf.js/rpc.Service.html

Calls a service method through the configured rpcImpl.

```APIDOC
## rpcCall(method, requestCtor, responseCtor, request, callback)

### Description
Calls a service method through the provided rpcImpl.

### Parameters
- **method** (Method) - Required - Reflected or static method
- **requestCtor** (Constructor) - Required - Request constructor
- **responseCtor** (Constructor) - Required - Response constructor
- **request** (TReq) - Required - Request message or plain object
- **callback** (rpc.ServiceMethodCallback) - Required - Service callback
```

--------------------------------

### toJSON(toJSONOptions)

Source: https://protobufjs.github.io/protobuf.js/Service.html

Converts this service to a service descriptor.

```APIDOC
## toJSON(toJSONOptions)

### Description
Converts this service to a service descriptor.

### Parameters
- **toJSONOptions** (IToJSONOptions) - Optional - JSON conversion options

### Returns
- **IService** - Service descriptor
```

--------------------------------

### util.lcFirst(str)

Source: https://protobufjs.github.io/protobuf.js/util.html

Converts the first character of a string to lower case.

```APIDOC
## util.lcFirst(str)

### Description
Converts the first character of a string to lower case.

### Parameters
- **str** (string) - Required - String to convert

### Returns
- **string** - Converted string
```

--------------------------------

### new OneOf(name, fieldNames, options, comment)

Source: https://protobufjs.github.io/protobuf.js/OneOf.html

Constructs a new OneOf instance to represent a oneof field in a protobuf definition.

```APIDOC
## Constructor: new OneOf(name, fieldNames, options, comment)

### Description
Constructs a new oneof instance for reflection purposes.

### Parameters
- **name** (string) - Required - Oneof name
- **fieldNames** (Array<string> | Object<string, *>) - Optional - Field names
- **options** (Object<string, *>) - Optional - Declared options
- **comment** (string) - Optional - Comment associated with this field
```

--------------------------------

### util.setProperty(dst, path, value, ifNotSet)

Source: https://protobufjs.github.io/protobuf.js/util.html

Sets the value of a property by property path. If a value already exists, it is turned to an array.

```APIDOC
## util.setProperty(dst, path, value, ifNotSet)

### Description
Sets the value of a property by property path. If a value already exists, it is turned to an array.

### Parameters
- **dst** (Object<string, *>) - Required - Destination object
- **path** (string) - Required - dot '.' delimited path of the property to set
- **value** (Object) - Required - the value to set
- **ifNotSet** (boolean) - Optional - Sets the option only if it isn't currently set

### Returns
- **Object<string, *>** - Destination object
```

--------------------------------

### util.path.isAbsolute

Source: https://protobufjs.github.io/protobuf.js/util.path.html

Checks if a path is absolute.

```APIDOC
## util.path.isAbsolute

### Description
Determines whether the provided path string is an absolute path.

### Parameters
- **path** (string) - Required - The path to check.
```

--------------------------------

### int64(value)

Source: https://protobufjs.github.io/protobuf.js/BufferWriter.html

Writes a signed 64 bit value as a varint.

```APIDOC
## int64(value)

### Description
Writes a signed 64 bit value as a varint.

### Parameters
- **value** (Long|number|string) - Required - Value to write

### Throws
- **TypeError** - If value is a string and no long library is present.

### Returns
- **Writer** - Returns the writer instance.
```

--------------------------------

### lookupType(path)

Source: https://protobufjs.github.io/protobuf.js/NamespaceBase.html

Looks up the type at the specified path, relative to this namespace. Throws an error if the path does not point to a type.

```APIDOC
## lookupType(path)

### Description
Looks up the type at the specified path, relative to this namespace. This method throws an error if the path does not point to a type.

### Parameters
- **path** (string | Array<string>) - Required - Path to look up

### Returns
- **Type** - Looked up type

### Throws
- **Error** - If path does not point to a type
```

--------------------------------

### util.jsonName(str)

Source: https://protobufjs.github.io/protobuf.js/util.html

Converts a proto field name to its protoc-compatible JSON name.

```APIDOC
## util.jsonName(str)

### Description
Converts a proto field name to its protoc-compatible JSON name.

### Parameters
- **str** (string) - Required - Proto field name

### Returns
- **string** - JSON name
```

--------------------------------

### util.makeProp(obj, key, enumerable)

Source: https://protobufjs.github.io/protobuf.js/util.html

Makes a property safe for assignment as an own property.

```APIDOC
## util.makeProp(obj, key, enumerable)

### Description
Makes a property safe for assignment as an own property.

### Parameters
- **obj** (Object<string, *>) - Required - Object
- **key** (string) - Required - Property key
- **enumerable** (boolean) - Optional - Whether the property should be enumerable (default: true)

### Returns
- **undefined**
```

--------------------------------

### fromObject(object)

Source: https://protobufjs.github.io/protobuf.js/Type.html

Creates a new message of this type from a plain object.

```APIDOC
## fromObject(object)

### Description
Creates a new message of this type from a plain object. Also converts values to their respective internal types.

### Parameters
- **object** (Object<string, *>) - Required - Plain object to convert

### Returns
- **ReflectedMessage** - Message instance
```

--------------------------------

### lookup(path, filterTypes, parentAlreadyChecked)

Source: https://protobufjs.github.io/protobuf.js/Root.html

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

```APIDOC
## lookup(path, filterTypes, parentAlreadyChecked)

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

### Parameters
- **path** (string | Array<string>) - Required - Path to look up
- **filterTypes** (*) - Required - Filter types, any combination of the constructors of protobuf.Type, protobuf.Enum, protobuf.Service etc.
- **parentAlreadyChecked** (boolean) - Optional - If known, whether the parent has already been checked (default: false)

### Returns
- **ReflectionObject | null** - Looked up object or null if none could be found.
```

--------------------------------

### toJSON(toJSONOptions)

Source: https://protobufjs.github.io/protobuf.js/Method.html

Converts this method to a method descriptor.

```APIDOC
## toJSON(toJSONOptions)

### Description
Converts this method to a method descriptor.

### Parameters
- **toJSONOptions** (IToJSONOptions) - Optional - JSON conversion options

### Returns
- **IMethod** - Method descriptor
```

--------------------------------

### Message.create(properties)

Source: https://protobufjs.github.io/protobuf.js/Message.html

Creates a new message of this type using the specified properties.

```APIDOC
## Message.create(properties)

### Description
Creates a new message of this type using the specified properties.

### Parameters
- **properties** (Object<string, *>) - Optional - Properties to set

### Returns
- **T** - Message instance
```

--------------------------------

### lookupType(path)

Source: https://protobufjs.github.io/protobuf.js/Root.html

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

```APIDOC
## lookupType(path)

### Description
Looks up the type at the specified path, relative to this namespace. Throws if path does not point to a type.

### Parameters
- **path** (string | Array<string>) - Required - Path to look up

### Throws
- **Error** - If path does not point to a type.

### Returns
- **Type** - Looked up type.
```

--------------------------------

### sint64()

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Reads a zig-zag encoded varint as a signed 64 bit value.

```APIDOC
## sint64()

### Description
Reads a zig-zag encoded varint as a signed 64 bit value.

### Returns
- **Long** - Value read
```

--------------------------------

### converter.fromObject(mtype)

Source: https://protobufjs.github.io/protobuf.js/converter.html

Generates a plain object to runtime message converter specific to the specified message type.

```APIDOC
## converter.fromObject(mtype)

### Description
Generates a plain object to runtime message converter specific to the specified message type.

### Parameters
- **mtype** (Message type) - Required - The message type to generate the converter for.

### Returns
- **Codegen** - A Codegen instance.
```

--------------------------------

### util.utf8.write(string, buffer, offset)

Source: https://protobufjs.github.io/protobuf.js/util.utf8.html

Writes a string as UTF8 bytes into a buffer at the specified offset.

```APIDOC
## util.utf8.write(string, buffer, offset)

### Description
Writes a string as UTF8 bytes.

### Parameters
- **string** (string) - Source string.
- **buffer** (Uint8Array) - Destination buffer.
- **offset** (number) - Destination offset.

### Returns
- **number** - The number of bytes written.
```

--------------------------------

### util.path.normalize(path)

Source: https://protobufjs.github.io/protobuf.js/util.path.html

Normalizes the specified path.

```APIDOC
## util.path.normalize(path)

### Description
Normalizes the specified path.

### Parameters
- **path** (string) - Required - Path to normalize

### Returns
- **string** - Normalized path
```

--------------------------------

### uint32()

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Reads a varint as an unsigned 32 bit value.

```APIDOC
## uint32()

### Description
Reads a varint as an unsigned 32 bit value.

### Returns
- **number** - Value read
```

--------------------------------

### bytes(value)

Source: https://protobufjs.github.io/protobuf.js/BufferWriter.html

Writes a sequence of bytes to the buffer.

```APIDOC
## bytes(value)

### Description
Writes a sequence of bytes to the current buffer position.

### Parameters
- **value** (Uint8Array | string) - Required - The buffer or base64 encoded string to write.

### Returns
- **Writer** - Returns the writer instance for chaining.
```

--------------------------------

### ITokenizerHandle Interface

Source: https://protobufjs.github.io/protobuf.js/ITokenizerHandle.html

The ITokenizerHandle interface provides methods to traverse tokens and access current state information.

```APIDOC
## ITokenizerHandle

### Description
Handle object returned from the tokenize process, providing methods to navigate tokens and track the current line.

### Properties
- **next** (TokenizerHandleNext) - Gets the next token and advances (returns null on eof).
- **peek** (TokenizerHandlePeek) - Peeks for the next token (returns null on eof).
- **push** (TokenizerHandlePush) - Pushes a token back to the stack.
- **skip** (TokenizerHandleSkip) - Skips a token, returns its presence and advances or, if non-optional and not present, throws.
- **cmnt** (TokenizerHandleCmnt) - Gets the comment on the previous line or the line comment on the specified line, if any.
- **line** (number) - Current line number.
```

--------------------------------

### Type.fromJSON(name, json, depth)

Source: https://protobufjs.github.io/protobuf.js/Type.html

Creates a message type from a message type descriptor.

```APIDOC
## Type.fromJSON(name, json, depth)

### Description
Creates a message type from a message type descriptor.

### Parameters
- **name** (string) - Required - Message name
- **json** (IType) - Required - Message type descriptor
- **depth** (number) - Optional - Current nesting depth, defaults to 0

### Returns
- **Type** - Created message type
```

--------------------------------

### bytes()

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Reads a sequence of bytes preceded by its length as a varint.

```APIDOC
## bytes()

### Description
Reads a sequence of bytes from the buffer, where the length of the sequence is specified by a preceding varint.

### Returns
- **Buffer** - The sequence of bytes read.
```

--------------------------------

### setOption(name, value, ifNotSet)

Source: https://protobufjs.github.io/protobuf.js/Service.html

Sets an option on the reflection object.

```APIDOC
## setOption(name, value, ifNotSet)

### Description
Sets an option.

### Parameters
- **name** (string) - Required - Option name
- **value** (*) - Required - Option value
- **ifNotSet** (boolean) - Optional - Sets the option only if it isn't currently set

### Returns
- **ReflectionObject** - this
```

--------------------------------

### Type.generateConstructor(mtype)

Source: https://protobufjs.github.io/protobuf.js/Type.html

Generates a constructor function for the specified type.

```APIDOC
## Type.generateConstructor(mtype)

### Description
Generates a constructor function for the specified type.

### Parameters
- **mtype** (Type) - Required - Message type

### Returns
- **Codegen** - Codegen instance
```

--------------------------------

### MapField.fromJSON(name, json)

Source: https://protobufjs.github.io/protobuf.js/MapField.html

Constructs a map field from a map field descriptor.

```APIDOC
## MapField.fromJSON(name, json)

### Description
Constructs a map field from a map field descriptor.

### Parameters
- **name** (string) - Required - Field name
- **json** (IMapField) - Required - Map field descriptor

### Returns
- **MapField** - Created map field

### Throws
- **TypeError** - If arguments are invalid
```

--------------------------------

### sfixed64s(array)

Source: https://protobufjs.github.io/protobuf.js/BufferReader.html

Reads a packed repeated field of signed 64 bit fixed values.

```APIDOC
## sfixed64s(array)

### Description
Reads a packed repeated field of signed 64 bit fixed values.

### Parameters
- **array** (Array<(Long|number)>) - Optional - Array to read into; a new one is created if omitted

### Returns
- **Array<(Long|number)>** - Array read into
```

--------------------------------

### util.LongBits.from(value)

Source: https://protobufjs.github.io/protobuf.js/util.LongBits.html

Constructs a new LongBits instance from a number, Long object, or string.

```APIDOC
## util.LongBits.from(value)

### Description
Constructs a new LongBits instance from a provided number, Long, or string value.

### Parameters
- **value** (Long|number|string) - Required - The value to convert.
```
Tokens:
Raw