https://github.com/jkulvich/tobin

💻 TypeScript library for binary conversion
https://github.com/jkulvich/tobin

bin binary bytes casting int32 javascript marshaling serialization types typescript

Last synced: 12 days ago
JSON representation

💻 TypeScript library for binary conversion

• Host: GitHub
• URL: https://github.com/jkulvich/tobin
• Owner: jkulvich
• License: mit
• Created: 2020-06-05T22:48:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T18:52:36.000Z (about 2 years ago)
• Last Synced: 2024-12-19T22:29:52.615Z (20 days ago)
• Topics: bin, binary, bytes, casting, int32, javascript, marshaling, serialization, types, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/tobin
• Size: 155 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CircleCI](https://circleci.com/gh/jkulvich/tobin.svg)](https://circleci.com/gh/jkulvich/tobin)

[![Master Version](https://img.shields.io/github/package-json/v/jkulvich/tobin/master.svg?style=flat-square)](https://github.com/jkulvich/tobin)

[![GitHub](https://img.shields.io/github/license/jkulvich/tobin?style=flat-square)](https://github.com/jkulvich/tobin/blob/master/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/jkulvich/tobin?style=flat-square)](https://github.com/jkulvich/tobin/issues)

[![npm](https://img.shields.io/npm/dw/tobin?style=flat-square)](https://www.npmjs.com/package/tobin)

[![GitHub top language](https://img.shields.io/github/languages/top/jkulvich/tobin?style=flat-square)](https://github.com/jkulvich/tobin)

# :construction: Please, wait for release

If you need in stability, please wait for release before use.

API may be change till release.

- [:ru: RUS](./README.ru.md) - Русская документация

- [:uk: ENG](./README.md) - English documentation

# About

This is small and lightweight library for binary conversion written on TypeScript.

The library allows creating and parsing binary structures.

Or it can be used as a part of big binary serialization library.  

(P.S. Coming soon)

# Installation

:cat2: with **yarn**:  

`yarn add tobin`

:wrench: with **npm**:  

`npm i tobin`

# Repo and issues

:floppy_disk: repo: https://github.com/jkulvich/tobin  

:speech_balloon: issues: https://github.com/jkulvich/tobin/issues

# Supported types

- [x] Byte

- [x] SByte

- [x] Int16

- [x] UInt16

- [x] Int32

- [x] UInt32

- [ ] Int64 // ES2020 only with BigInt

- [ ] UInt64 // ES2020 only with BigInt

- [ ] Float

- [ ] Double

- [x] Bool

- [ ] String

    - [x] String // Null Terminated String (default)

    - [x] ShortString // Short String (255 bytes max)

    - [ ] FixedString // String with fixed size. Null Terminated if less than size

# Examples

Formal:

```

tobin.(convert|parse)(S?Byte|U?Int16|U?Int32|U?Int64|Float|Double|Bool|(Short|Fixed)?String)

```

```javascript

import tobin from "tobin"

tobin.convertInt32(500) // [0, 0, 1, 244]

tobin.convertInt32(-500) // [128, 0, 1, 244]

tobin.convertUInt16(65535) // [255, 255]

tobin.convertByte(128) // [128]

tobin.convertString("Hello") // [104, 101, 108, 108, 111, 0]

tobin.convertShortString("Hello") // [ 5, 104, 101, 108, 108, 111 ]

tobin.parseSByte(new Uint8Array([129])) // -1

tobin.parseString(new Uint8Array([104, 101, 108, 108, 111, 0])) // "Hello"

tobin.parseShortString(new Uint8Array([5, 104, 101, 108, 108, 111])) // "Hello"

```

# Performance