# jspack.ts
> Library to pack/unpack binary data
Latest version **1.0.9** (published 2022-11-07) · MIT license · 0 weekly downloads
## Install
```sh
npm install jspack.ts
pnpm add jspack.ts
yarn add jspack.ts
bun add jspack.ts
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.9 |
| Published | 2022-11-07 |
| First published | 2022-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 29.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Loginov Ilya |
| Maintainers | loginov_ilya |
| Keywords | binary, pack, unpack, decode, encode, endian, endianness, big endian, little endian, unsigned, IEEE 754, 754, array, char, short int, int, int 64, long int, long long int, null, byte, string |
## Links
- npm: https://www.npmjs.com/package/jspack.ts
- Repository: https://github.com/LoginovIlya/jspack.ts
- Issues: https://github.com/LoginovIlya/jspack.ts/issues
- npm.io page: https://npm.io/package/jspack.ts
## Alternatives
- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads
## Recent versions
- 1.0.9 (latest) — 2022-11-07
- 1.0.8 — 2022-11-07
- 1.0.7 — 2022-11-07
- 1.0.5 — 2022-11-07
- 1.0.4 — 2022-11-07
- 1.0.3 — 2022-11-06
- 1.0.2 — 2022-11-05
- 1.0.1 — 2022-11-05
## README
JsPack.ts
Library to pack/unpack binary data
JsPack is a library for working with binary data in JavaScript using the Uint8Array object.
To ensure maximum stability, this library has 100% test coverage.
The library was created using typescript for more convenient work with many types.
---
## Installation
Install with npm:
```
npm i jspack.ts
```
## Formats
### Superscripts:
**1:** Unpack with 'f' and 'd' key can return NaN. The value NAN is used to represent a value that is an error. This is represented when exponent field is all ones with a zero sign bit or a mantissa that it not 1 followed by zeros. This is a special value that might be used to denote a variable that doesn’t yet hold a value.
## Endianness
| Key | Description |
|-----|----------------------|
| < | Little endian |
| \> | Big endian |
| ! | Network (big endian) |
## Initialization
#### ES6:
```typescript
import { JSPack, JSPackFormat, JSPackEndianness } from 'jspack.ts';
```
#### Node:
```typescript
const { JSPack, JSPackFormat, JSPackEndianness } = require('jspack.ts');
```
## Examples
### Formats:
- [Char (ascii)](#char-ascii)
- [Int](#int)
- [Int64 (long long int)](#int64-long-long-int)
- [String (ASCII chars)](#string-ascii-chars)
- [Array (Raw data)](#array-raw-data)
- [IEEE 754 (Float, Double)](#ieee-754-float-double)
- [Null Byte](#null-byte)
---
### Char (ascii)
#### Pack:
```typescript
// Return Uint8Array(97)
JSPack.Pack(JSPackFormat.c, 'a', JSPackEndianness.bigEndian);
```
#### Unpack:
```typescript
// Return 'b'
JSPack.Unpack(JSPackFormat.c, new Uint8Array([98]), JSPackEndianness.bigEndian);
```
---
### Int
#### Pack:
```typescript
// Return Uint8Array(0x85)
JSPack.Pack(JSPackFormat.b, -123, JSPackEndianness.bigEndian);
```
#### Unpack:
```typescript
// Return -123
JSPack.Unpack(JSPackFormat.b, new Uint8Array([0x85]), JSPackEndianness.bigEndian);
```
---
### Int64 (long long int)
#### Pack:
```typescript
// Return Uint8Array(0x00, 0x01, 0xEE, 0x0D, 0x32, 0xDE, 0xBC, 0xD1)
const longLongInt = {
low: 0x32DEBCD1,
high: 0x0001EE0D,
unsigned: true,
};
JSPack.Pack(JSPackFormat.q, longLongInt, JSPackEndianness.bigEndian);
```
#### Unpack:
```typescript
const longLongIntBinary = new Uint8Array([0x00, 0x01, 0xEE, 0x0D, 0x32, 0xDE, 0xBC, 0xD1]);
// Return { low: 0x32DEBCD1, high: 0x0001EE0D, unsigned: true }
JSPack.Unpack(JSPackFormat.q, longLongIntBinary, JSPackEndianness.bigEndian);
```
---
### String (ASCII chars)
#### Pack:
```typescript
// Return Uint8Array(97, 98, 99)
JSPack.Pack(JSPackFormat.s, 'abc', JSPackEndianness.bigEndian);
```
#### Unpack:
```typescript
// Return 'abc'
JSPack.Unpack(JSPackFormat.s, new Uint8Array([97, 98, 99]), JSPackEndianness.bigEndian);
```
---
### Array (Raw data)
#### Pack:
```typescript
// Return Uint8Array(0x61, 0x62, 0x63)
JSPack.Pack(JSPackFormat.A, [97, 98, 99], JSPackEndianness.bigEndian);
```
#### Unpack:
```typescript
// Return [97, 98, 99]
JSPack.Unpack(JSPackFormat.A, new Uint8Array([0x61, 0x62, 0x63]), JSPackEndianness.bigEndian);
```
---
### IEEE 754 (Float, Double)
#### Pack:
```typescript
// Return Uint8Array(0x47, 0x59, 0x3, 0x55)
JSPack.Pack(JSPackFormat.f, 55555.333, JSPackEndianness.bigEndian);
```
#### Unpack:
```typescript
// Return 55555.33203125
JSPack.Unpack(JSPackFormat.f, new Uint8Array([0x47, 0x59, 0x3, 0x55]), JSPackEndianness.bigEndian);
```
---
### Null Byte
#### Pack:
```typescript
// Return Uint8Array(0)
JSPack.Pack(JSPackFormat.x, 0x0, JSPackEndianness.bigEndian);
```
#### Unpack:
```typescript
// Return 0
JSPack.Unpack(JSPackFormat.x, new Uint8Array([0]), JSPackEndianness.bigEndian);
```
---
_Source: https://npm.io/package/jspack.ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._