@types/pbf

What is @types/pbf?

@types/pbf provides TypeScript type definitions for the pbf library, which is a low-level, fast, and efficient library for encoding and decoding Protocol Buffers (protobuf) data.

What are @types/pbf's main functionalities?

Encoding Data

This feature allows you to encode data into a Protocol Buffers format. The code sample demonstrates how to write a varint (variable-length integer) and get the encoded buffer.

const Pbf = require('pbf');

const pbf = new Pbf();
pbf.writeVarint(123); // Write a varint
const buffer = pbf.finish(); // Get the encoded buffer

Decoding Data

This feature allows you to decode data from a Protocol Buffers format. The code sample demonstrates how to read a varint from an encoded buffer.

const Pbf = require('pbf');

const buffer = new Uint8Array([0x08, 0x7b]); // Example buffer
const pbf = new Pbf(buffer);
const value = pbf.readVarint(); // Read a varint
console.log(value); // 123

Handling Nested Messages

This feature allows you to handle nested messages within Protocol Buffers. The code sample demonstrates how to write a nested message with a varint and a string field.

const Pbf = require('pbf');

const pbf = new Pbf();
pbf.writeMessage(1, (pbf) => {
  pbf.writeVarintField(1, 123);
  pbf.writeStringField(2, 'example');
});
const buffer = pbf.finish();

Other packages similar to @types/pbf

protobufjs

protobufjs is a comprehensive library for working with Protocol Buffers in JavaScript. It provides both runtime and static code generation, making it more versatile than pbf. It also includes a robust set of features for working with .proto files, which is not a focus of pbf.

google-protobuf

google-protobuf is the official Protocol Buffers library for JavaScript provided by Google. It offers a complete implementation of Protocol Buffers, including support for all protobuf features. It is more feature-rich but also heavier and potentially slower than pbf.

README

Installation

npm install --save @types/pbf

Summary

This package contains type definitions for pbf (https://github.com/mapbox/pbf).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pbf.

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Christian Schwarz.