npmpackage.info

Gathering detailed insights and metrics for binary-data

Other packages similar to binary-data

has-binary-data

0.1.5

A function that takes anything in javascript and returns true if its argument contains binary data.

functional-red-black-tree

1.0.1

A fully persistent balanced binary search tree

has-binary

0.1.7

A function that takes anything in javascript and returns true if its argument contains binary data.

concat-stream

2.0.0

writable stream that concatenates strings or binary data and calls a callback with the result

Gathering detailed insights and metrics for binary-data

binary-data - 0.6.0 | npmpackage.info

binary-data

Declarative binary data encoder / decoder

0.6.0

MIT

JavaScript

Installations

npm install binary-data

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=6

Node Version

10.14.1

NPM Version

6.4.1 Score

84.4

Supply Chain

99.6

Quality

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

19

Closed

14

Merged

4

Issues

Open

6

Total

17

Closed

11

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

reklatsmasters

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

12 Stars

112 Commits

11 Forks

1 Watchers

15 Branches

2 Contributors

Updated on Mar 30, 2025

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

0.6.0

Package Id

binary-data@0.6.0

Size

210.56 kB

NPM Version

6.4.1

Node Version

10.14.1

Published on

Dec 10, 2018

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

generate-function is-plain-object

Dev Dependencies

@nodertc/eslint-config binary bl eslint jest prettier

binary-data

Declarative binary data encoder / decoder. This module works almost like as binary or restructure but provided modern and clean api. It inspired by abstract-encoding interface.

Support

Usage

decode

1const { decode, createDecode, types: { uint8, array, string } } = require('binary-data')
2
3// 1. Define your own schema as plain object
4const protocol = {
5  type: uint8,
6  value: array(string(null), uint8)
7}
8
9const message = Buffer.from([1, 2, 3, 4, 5, 6, 0]);
10
11// Just decode message
12const packet = decode(message, protocol)
13
14// 2 Also you may decode messages from streams
15const net = require('net');
16
17const socket = net.createConnection({ port: 8124 });
18const istream = createDecode(protocol);
19
20socket.pipe(istream).on('data', packet => {
21  console.log(packet.type, packet.value);
22});

encode

1const { encode, createEncode, types: { uint8, string } } = require('binary-data')
2
3const protocol = {
4  type: uint8,
5  value: string(uint8)
6}
7
8const hello = {
9  type: 12,
10  value: 'my random data'
11}
12
13// Just encode message
14const ostream = encode(hello, protocol);
15const packet = ostream.slice();
16
17// Or you may encode messages into a stream
18const net = require('net');
19
20const ostream = createEncode(protocol);
21const socket = net.createConnection({ port: 8124 }, () => {
22  ostream.write(hello);
23});
24
25ostream.pipe(socket);
26
27// You may combine multiple schemes into one stream
28const ostream = createEncode();
29
30encode(obj1, ostream, protocol1);
31encode(obj2, ostream, protocol2);
32encode(obj3, ostream, protocol3);
33
34const packet = ostream.slice();
35

See stun or dtls module for complete example.

Perfomance

Decoding DTLS ClientHello packet, nodejs 10.14.1 / Ubuntu 16.04 x64

name	time
binary data	637.900ms
binary	2229.218ms

API

encode(obj: any, [target: BinaryStream], type: Object): BinaryStream
decode(source: BinaryStream|Buffer, type: Object): any
encodingLength(item: any, type: Object): Number
createEncodeStream([type: Object]): BinaryStream
createDecodeStream([type: Object|Buffer]): BinaryStream
createEncode([type: Object]): BinaryStream
createDecode([type: Object|Buffer]): BinaryStream
Types

`decode(source: BinaryStream|Buffer, type: Object): any`

Reads any data from stream rstream using data type type. See examples above.

`encode(obj: any, [target: BinaryStream], type: Object): BinaryStream`

Writes any data obj to stream target using data type type. See examples above.

`encodingLength(item: any, type: Object): Number`

Return the amount of bytes needed to encode item using type.

`createEncodeStream([type: Object]): BinaryStream`

`createEncode([type: Object]): BinaryStream`

Create instance of BinaryStream.

`createDecodeStream([type: Object|Buffer]): BinaryStream`

`createDecode([type: Object|Buffer]): BinaryStream`

Create instance of BinaryStream.

`types: Object`

Contains all primitive data types.

Types

`(u)int(8, 16, 24, 32, 40, 48)(be, le)`

Low-level integer types.

1const schema = {
2  type: int8
3}
4
5// define int64 as buffer and use your loved library for big numbers
6const int64 = buffer(8)

`(double, float)(be, le)`

Low-level floating-point types.

1const schema = {
2  size: doublele
3}

`array(type: Object, length: number|Object|Function, lengthType: string)`

Array of low-level or user defined types. Argument type should be primitive type or user defined scheme. Argument length should be a number, number type or function. Argument lengthType should be bytes or count (default).

1array(uint8, 3) // 3 x uint8
2
3const schema = {
4  length: uint8,
5  type: uint32be,
6  items: array(uint16, ({node}) => node.length, 'bytes')
7}
8
9// difference between `bytes` or `count`
10
11array(uint16, uint8)
12// |   0x2  | 0x0 0x1 | 0x0 0x2 |
13// | length | item 1  |  item 2 |
14// bytes = 1 + 4, length = 2
15
16array(uint16, uint8, 'bytes')
17// |   0x4  | 0x0 0x1 | 0x0 0x2 |
18// | length | item 1  |  item 2 |
19// bytes = 1 + 4, length = 4

`string(length)`

Low-level string type. Argument length can be number, null for C - strings, type for size-prefixed data or function.

`bool(type: any)`

Convert provided type to / from boolean. Argument type should be an number type.

1const schema = bool(uint8)
2const rstream = createDecodeStream(buf) // 0x01 0
3
4decode(rstream, schema) // return true
5decode(rstream, schema) // return false

`buffer(length: Object|null|number)`

Low-level buffer type. Argument length can be number, number type for size-prefixed data, function or null.

1buffer(5) // buffer should be 5 bytes
2
3buffer(uint8) // length prefixed buffer
4// |   0x3  | 0xa 0xb 0xc
5// | length | data
6
7const packet = {
8  header: {
9    length: uint16be
10  },
11  data: buffer(({node}) => node.header.length % 2) // function should return actual length
12}

`reserved(type, count)`

Special type to skip any data. Argument count should be a number, number type or function.

1const packet = {
2  type: uint8,
3  _padding: reserved(uint8, 3)
4}
5
6decode(rstream, packet) // return { type }

`when(fn: function(context): boolean, type)`

Special type for conditions. Argument fn should be a function and should return boolean value. The type argument will be evaluated when the first one returns positive value.

1const schema = {
2  type: uint8,
3  bytes: when(({ node }) => node.type === 1, string(uint16be)),
4  list: when(({ node }) => node.type === 2, array(uint32be, uint8))
5}

`select(when, ..., defaultType)`

The second type for conditions. The same as switch operator in js. Argument defaultType may be any known type excluding user schemas.

1const schema = {
2  id: uint8,
3  payload: select(when(({ node }) => node.id === 1, string(uint16be)), buffer(uint16be))
4}

License

MIT, 2017 (c) Dmitriy Tsvettsikh

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

65 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More