bebop
v3.1.3
Published
The TypeScript runtime for Bebop, a schema-based binary serialization format.
Downloads
858
Readme
Bebop TypeScript Runtime
The official Bebop runtime for TypeScript and JavaScript.
Overview
This package provides the essential runtime components for using Bebop-generated code in TypeScript and JavaScript projects. It enables blazing fast, typesafe binary serialization with minimal overhead.
Features
- 🚀 High-performance binary serialization
- 📦 Tiny runtime footprint
- 🔒 Type-safe operations
- 🌐 Works everywhere: Node.js, browsers, serverless platforms, and more
- 🍃 Zero dependencies
- 🏋️ Lightweight - minimal impact on your bundle size
- 🧰 Provides runtime types for enhanced type safety
- 🔧 Supports dynamic encoding/decoding with binary schemas
Installation
npm install bebop
Usage
While the Bebop TypeScript runtime is primarily used with code generated by bebopc
, it also provides useful types and utilities for direct use in your code.
Example usage with generated code:
import { Person } from './generated/schema';
const person = new Person({
name: "Spike Spiegel",
age: 27
});
// Encode to binary
const encoded = person.encode();
// Decode from binary
const decoded = Person.decode(encoded);
For more advanced use cases, such as dynamic encoding/decoding with binary schemas, refer to our Binary Schema documentation.
Documentation
For comprehensive documentation and guides, visit:
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
Bebop is open-source software licensed under the Apache License.
For more information about Bebop, visit bebop.sh.