Minimal JSON-like binary schema-full protocol for JS/TS with BYO runtime data validations.
- Small (< 1.5 KB)
- Fast
- Runtime data validations
- 36 types
BooleanUInt8UInt16UInt32Int8Int16Int32Float32Float64Ascii8Ascii16Unicode8Unicode16ObjectArray8Array16EnumTupleNullableBooleanNullableUInt8NullableUInt16NullableUInt32NullableInt8NullableInt16NullableInt32NullableFloat32NullableFloat64NullableAscii8NullableAscii16NullableUnicode8NullableUnicode16NullableObjectNullableArray8NullableArray16NullableEnumNullableTuple
- Estimate payload size
- Static type inference
Encodes JS data into ArrayBuffer based on Type.
const arrayBuffer = encode({
type: Type.Object,
value: [
{ key: "name", type: Type.Ascii },
{ key: "age", type: Type.UInt8 }
]
}, {
type: "Yamiteru",
age: 27
});Decodes ArrayBuffer into JS data based on Type.
const data = decode({
type: Type.Object,
value: [
{ key: "name", type: Type.Ascii },
{ key: "age", type: Type.UInt8 }
]
}, arrayBuffer);Estimates payload size of Type in bytes and chunks based on provided Settings.
const {
bytes, // 66
chunks // 9
} = estimate({
type: Type.Object,
value: [
{ key: "name", type: Type.Ascii, maxLength: 64 },
{ key: "age", type: Type.UInt8 }
]
}, {
MAX_POOL_SIZE: 256,
DEFAULT_POOL_SIZE: 16,
DEFAULT_CHUNK_SIZE: 8,
});Once you create a Type you can easily infer it with Infer.
encode uses Infer for its input value and decode for its output value.
const user = {
type: Type.Object,
value: [
{ key: "name", type: Type.Ascii },
{ key: "age", type: Type.UInt8 }
]
} as const;
// {
// type: string,
// age: number
// }
type User = Infer<typeof user>;{
type:
| Type.Boolean
| Type.NullableBoolean;
}{
type:
| Type.UInt8
| Type.UInt16
| Type.UInt32
| Type.NullableUInt8
| Type.NullableUInt16
| Type.NullableUInt32;
}{
type:
| Type.Int8
| Type.Int16
| Type.Int32
| Type.NullableInt8
| Type.NullableInt16
| Type.NullableInt32;
}{
type:
| Type.Float32
| Type.Float64
| Type.NullableFloat32
| Type.NullableFloat64;
}{
type:
| Type.Ascii8
| Type.Ascii16
| Type.NullableAscii8
| Type.NullableAscii16;
}{
type:
| Type.Unicode8
| Type.Unicode16
| Type.NullableUnicode8
| Type.NullableUnicode16;
}{
type:
| Type.Object
| Type.NullableObject;
value: (AnyType & Required<Type.Keyable>)[];
}{
type:
| Type.Array8
| Type.Array16
| Type.NullableArray8
| Type.NullableArray16;
value: AnyType;
}{
type:
| Type.Tuple
| Type.NullableTuple;
value: AnyType[];
}{
type:
| Type.Enum
| Type.NullableEnum;
value: unknown[];
}Used in Object for property names.
{
key?: string;
}Any type can be asserted by adding assert property to it.
In encode it's run before encoding and in decode it's run after decoding.
If type is nullable and the value is null we do not run assert in either encode or decode.
{
assert?: (v: unknown) => asserts v is unknown;
}