Code Monkey home page Code Monkey logo

stream-binary's Introduction

Stream Binary for JavaScript/TypeScript

Overview

It is a library designed to optimize the size of the messages we send over the network.

How to use

The library is separated into two main classes, one for reading and another for writing.

The best way to teach how it is used is with an example, so let's go.

Installing in your project...

npm:

npm install stream-binary

yarn:

yarn add stream-binary

BinaryWriter example

// Initialize BinaryWritter
const writer = new BinaryWriter();

// Write any string
writer.writeString('BinaryReaderWorking');

const buffer = writer.getBuffer();
const bufferHex = buffer.toString('hex'); // 001342696e617279526561646572576f726b696e67

BinaryReader example

// Buffer to read (message packet)
const buffer = Buffer.from('001342696e617279526561646572576f726b696e67', 'hex');
// Initialize BinaryReader with entry buffer
const reader = new BinaryReader(buffer);
// read buffer content
const result = reader.readString();

Supported types

  • string (set a two-byte prefix to know the size of the string.)
  • short
  • int
  • byte
  • float
  • double
  • buffer (set a two-byte prefix to know the size of the buffer.)

Next support types

  • date
  • time
  • ushort
  • uint
  • ulong

stream-binary's People

Contributors

bernatvadell avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.