@types/google-protobuf

What is @types/google-protobuf?

@types/google-protobuf provides TypeScript type definitions for the google-protobuf library, which is used for working with Protocol Buffers in JavaScript. Protocol Buffers are a method developed by Google for serializing structured data, similar to XML or JSON.

What are @types/google-protobuf's main functionalities?

Creating a Protocol Buffer Message

This code demonstrates how to create a custom Protocol Buffer message class by extending the Message class from google-protobuf. It includes methods to get and set a field in the message.

const { Message } = require('google-protobuf');

class MyMessage extends Message {
  constructor() {
    super();
    this.myField = '';
  }

  getMyField() {
    return this.myField;
  }

  setMyField(value) {
    this.myField = value;
  }
}

const message = new MyMessage();
message.setMyField('Hello, World!');
console.log(message.getMyField());

Serializing and Deserializing Messages

This code demonstrates how to serialize a Protocol Buffer message to binary format and then deserialize it back to a message object. This is useful for efficient data storage and transmission.

const { MyMessage } = require('./my_message_pb');

const message = new MyMessage();
message.setMyField('Hello, World!');

// Serialize to binary format
const bytes = message.serializeBinary();

// Deserialize from binary format
const deserializedMessage = MyMessage.deserializeBinary(bytes);
console.log(deserializedMessage.getMyField());

Using Enums in Protocol Buffers

This code demonstrates how to define and use enums in Protocol Buffer messages. Enums are useful for representing a fixed set of constants in a message.

const { Message, Field, Enum } = require('google-protobuf');

const MyEnum = {
  UNKNOWN: 0,
  FIRST: 1,
  SECOND: 2
};

class MyMessage extends Message {
  constructor() {
    super();
    this.myEnumField = MyEnum.UNKNOWN;
  }

  getMyEnumField() {
    return this.myEnumField;
  }

  setMyEnumField(value) {
    this.myEnumField = value;
  }
}

const message = new MyMessage();
message.setMyEnumField(MyEnum.FIRST);
console.log(message.getMyEnumField());

Other packages similar to @types/google-protobuf

protobufjs

protobufjs is a pure JavaScript implementation of Protocol Buffers. It provides similar functionality to google-protobuf but is written entirely in JavaScript, making it more suitable for environments where native code compilation is not possible.

pbf

pbf is a small and fast JavaScript library for encoding and decoding Protocol Buffers. It is designed to be lightweight and efficient, making it a good choice for performance-critical applications.

protocol-buffers

protocol-buffers is a JavaScript implementation of Protocol Buffers that focuses on simplicity and ease of use. It provides a straightforward API for defining and working with Protocol Buffer messages.

README

Installation

npm install --save @types/google-protobuf

Summary

This package contains type definitions for google-protobuf (https://github.com/google/google-protobuf).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/google-protobuf.

Additional Details

• Last updated: Tue, 21 Nov 2023 08:36:24 GMT
• Dependencies: none

Credits

These definitions were written by Marcus Longmuir, and Chaitanya Kamatham.