Skip to content

A truly declarative library for binary file and protocol definition written in typescript

License

Notifications You must be signed in to change notification settings

tperale/binspector

Repository files navigation

🕵️ binspector, your binary file assistant

A truly declarative library for binary file and protocol definition written in typescript. Read binary files based on class definition and decorators directly on your webapp.

class ProtocolHeader {
  @Match(0x0E)
  @Relation(PrimitiveSymbol.u8)
  magic: number

  @Count(4)
  @Relation(PrimitiveSymbol.char)
  extension: string;

  @Relation(PrimitiveSymbol.u32)
  len: number;

  @Crc
  @Relation(PrimitiveSymbol.u32)
  crc: number;
}

enum RecordTypes {
  RecordStart = 0x01,
  RecordMsg = 0x02,
  RecordEnd = 0x03,
}

class Record {
  @Relation(PrimitiveSymbol.u32)
  id: number

  @Enum(RecordTypes)
  @Relation(PrimitiveSymbol.u8)
  type: RecordTypes

  @Until('\0')
  @Relation(PrimitiveSymbol.char)
  message: string;
}

class Protocol {
  @Relation(ProtocolHeader)
  header: ProtocolHeader

  @Count('header.len')
  @Relation(Record)
  message: Record
}

Features

  • It's a class ! Write method that will directly handle the binary content from the definition.
  • The binary file definition is re-used for typescript type checking.
  • Extensible. Binary readers based on DSL are hard to extend.
  • Support parsing (and serialisation in the future) of the binary file.
  • It works on the browser. You can create binary file decoder and encoder on your webapp frontend without depending on other library on your server.
  • Support the common operation done on binary files.
    • Endianness
    • Matching magic numbers
    • Bit fields and enum
    • Reference other structure
    • Conditions
  • No dependencies

Installation

> npm install binspector

Generate the documentation with the following command.

> npx typedoc --options typedoc.json

About

A truly declarative library for binary file and protocol definition written in typescript

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages