package
A javascript ES6 Decorator driven library to encode/decode javascript objects to/from binary optimized buffers to reduce payload on network
npm install nytraGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 1 packages.
40.6 kB
Includes dependencies.
Fast binary serialization for JavaScript/TypeScript with decorator-based DTO support.
Nytra helps you encode/decode plain values, arrays, objects, and class instances into compact binary buffers.
npm install nytraimport { Nytra, Types } from "nytra";
@Nytra.registerClass(2000)
class Player {
@Nytra.registerField(0, Types.TYPE_STRING)
name: string;
@Nytra.registerField(1, Types.TYPE_UINT16)
level: number;
@Nytra.registerField(2, Types.TYPE_STRING, { nullable: true })
guild: string | null = null;
constructor(name: string, level: number) {
this.name =
Nytra.encode(data, typeId?) -> Uint8ArrayNytra.decode(buffer) -> decoded valueNytra.autoguessType(data) -> internal type idNytra.getTypeIdForClass(ClassCtor) -> registered class type idNytra.registerClass(typeId) -> class decoratorNytra.registerField(position, typeOrClass, options?) -> field decoratorregisterField optionsnullable?: boolean - marks a field as nullable in class schemaUse constants from Types, for example:
TYPE_NULL, TYPE_BOOLEANTYPE_UINT8, TYPE_UINT16, TYPE_UINT32, TYPE_UINT64TYPE_INT8, TYPE_INT16, TYPE_INT32, TYPE_INT64TYPE_FLOAT32, TYPE_FLOAT64TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_JSON, TYPE_BIGINTBuild:
npm run buildRun tests (Bun):
bun testIf you see decorator typing/runtime issues, enable modern decorators + metadata in your TS setup:
{
"compilerOptions": {
"target": "ES2022",
"module": "nodenext",
"moduleResolution": "nodenext",
"lib": ["ES2022", "esnext.decorators", "esnext.decorators.metadata"]
}
}Nytra decorators use the new standard decorator context APIs (
ClassDecoratorContext,ClassFieldDecoratorContext).
For projecty relying on legacy TypeScript decorators, you can use the exported NytraExperimental class wrapping the new TC30 Decorators.
import {NytraExperimental, Types as T} from "nytra";
@NytraExperimental.registerClass(10000)
export class PageStats {
@NytraExperimental.registerField(0, T.TYPE_STRING)
version: string;
@NytraExperimental.registerField(1, T.TYPE_UINT32)
registrationCount: number;
}MIT