Serializers

import { Queue, JsonSerializer, MsgpackSerializer } from "@byteveda/flexiq";
import type { Serializer } from "@byteveda/flexiq";

Built-ins

new Queue({ dbPath: "flexiq.db", serializer: new MsgpackSerializer() });

import { Queue, CborSerializer } from "@byteveda/flexiq";

new Queue({ dbPath: "flexiq.db", serializer: new CborSerializer() });

SignedSerializer(secret, inner?) prefixes each payload with a 32-byte HMAC tag and verifies it (timing-safe) on read — authentication, not encryption. EncryptedSerializer(secret, inner?) goes further: AES-256-GCM gives confidentiality and integrity. Both derive their key from secret, so producers and workers must share it.

new Queue({
  dbPath: "flexiq.db",
  serializer: new EncryptedSerializer(process.env.FLEXIQ_SECRET!),
});

Payload codecs

A PayloadCodec is a reversible byte transform layered around a serializer — compression, encryption, signing — rather than a replacement for it. Codecs compose: a chain encodes in list order on the producer and decodes in reverse on the worker. Wire formats are part of the cross-SDK contract, so a codec-framed payload decodes from any FlexiQ SDK.

interface PayloadCodec {
  encode(data: Uint8Array): Uint8Array;
  decode(data: Uint8Array): Uint8Array;
}

Apply a chain queue-wide with QueueOptions.codec (wraps the serializer, covers every payload and result), or register named codecs via QueueOptions.codecs and opt individual tasks in with TaskOptions.codecs (payload only — results still use the plain serializer):

import { Queue, GzipCodec, HmacCodec } from "@byteveda/flexiq";

const queue = new Queue({
  dbPath: "flexiq.db",
  codec: [new GzipCodec(), new HmacCodec(hmacKey)], // encodes gzip, then hmac
});

Serializer interface

interface Serializer {
  serialize(value: unknown): Uint8Array;
  deserialize(bytes: Uint8Array): unknown;
}

The Rust core treats payloads as opaque bytes; serialization is entirely Node-side. Producers and workers must use a compatible serializer.

See the Serializers guide for a custom implementation.