mol_vary

v0.0.160

Published

21 hours ago

> Reference implementation of VaryPack - simple fast compact data binarization format.

0High
0Medium
0Low

$mol_vary $mol $mol_fail $mol_bigint_encode $mol_bigint $mol_charset_ucf $mol_charset $mol_charset_buffer $mol_bigint_decode $mol_dom $mol_dom_context $node $node_internal_check $node_internal $node_autoinstall $mol_run $mol_error_mix $mol_error $mol_func_name $mol_func $mol_object $mol_object2 $mol_ambient $mol_owning $mol_delegate $mol_fail_hidden $mol_type_writable $mol_type $mol_key $mol_env $mol_wire $mol_wire_sub $mol_wire_pub $mol_guid $mol_wire_cursor $mol_wire_sync $mol_wire_task $mol_wire_fiber $mol_wire_pub_sub $mol_dev_format $mol_dev $mol_after_tick $mol_after $mol_promise_like $mol_promise $mol_compare_deep $mol_compare $mol_log3 $mol_tree2_from_json $mol_tree2_from $mol_tree2 $mol_span $mol_tree2_from_string $mol_error_syntax $mol_tree2_to_string $mol_tree2_to $mol_maybe $mol_array_chunks $mol_array $mol_term_color $mol_term $mol_fail_log $mol_fail_catch $mol_try $mol_dom_serialize $mol_dom_parse

$mol_vary

Reference implementation of VaryPack - simple fast compact data binarization format.

Key Features

Deduplication by reference: same structures are stored as links to first entry. AKA "structured clone".
Intergated schema: schema always stored with data. AKA "schema less".
Structural typing: data mapped to classes by schema. Unique feature!
Decentralized extensibility: custom types support without central registry. Unique feature!
Single-pass: used auto-growable internal buffer.
Easy debug: tiny ints are packed as is, special types are packed as char.

Supported types

Primitives: null, undefined, boolean, number, bigint, string.
Buffers: Uint*Array, Int*Array, BigUint64Array, BigInt64Array, Float*Array.
Objects: Array, Object, Date, Map, Set, Element.

Comparison

VaryPack: $mol_vary - reference implementation.
CBOR: cbor-x - fastest implementation with all required extensions (which are standardized, although its don't have wide support).
MsgPack: msgpackr - fastest implementaion with all required extensions (which incompatible with other libs).

| | $mol_vary | cbor-x | msgpackr |----------------|-----------|-------------|--------- | Language | ✅ TS | ✅ TS+DTS | ❌ JS+DTS | Performance | ⭕ 100% | ✅ +20% | ✅ +50% | Packed Size | ✅ 100% | ❌ +40% | ❌ +30% | Lib Size | ✅ 4KB | ❌ 11 KB | ❌ 11 KB | Compatibility | ✅ std | ⭕ ext-std | ❌ ext

Benchmark results:

Chrome 142

API

Usage from NPM

Install mol_vary:

npm install mol_vary

Add import:

import { $mol_vary } from 'mol_vary'

Binarization

const buffer = $mol_vary.pack( list )

Pasing

const list = $mol_vary.take( buffer )

Register custom types

class Foo {
	
	constructor(
		readonly a: number,
		readonly b: number,
	) {}
	
}

// Make isolated Vary
const Vary = $mol_vary.zone()

// Add custom type support
Vary.type(
	Foo, // Instance super class
	[ 'a', 'b' ], // Keys as shape
	foo => [ foo.a, foo.b ], // Vals extractor
	([ a, b ])=> new Foo( a, b ), // Factory from vals
)

// Usage
const buffer = Vary.pack([ new Foo( 3, 4 ) ])
const foo = Vary.take( buffer )[0]

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme