Skip to content
Effect Days 2026 Get your ticket

MsgPack

11 exports Added in v1.0.0 Source

Combinators

duplex

Added in v1.0.0 Source

Signature

declare function duplex<R, IE, OE, OutDone, InDone>(self: Channel<Chunk<Uint8Array<ArrayBufferLike>>, Chunk<Uint8Array<ArrayBufferLike>>, OE, MsgPackError | IE, OutDone, InDone, R>): Channel<Chunk<unknown>, Chunk<unknown>, MsgPackError | OE, IE, OutDone, InDone, R>

duplexSchema

Added in v1.0.0 Source

Signature

declare const duplexSchema: {
<IA, II, IR, OA, OI, OR>(options: {
readonly inputSchema: Schema.Schema<IA, II, IR>;
readonly outputSchema: Schema.Schema<OA, OI, OR>;
}): <R, InErr, OutErr, OutDone, InDone>(self: Channel<Chunk<Uint8Array<ArrayBufferLike>>, Chunk<Uint8Array<ArrayBufferLike>>, OutErr, any, OutDone, InDone, R>) => Channel<Chunk<OA>, Chunk<IA>, any, InErr, OutDone, InDone, IR | OR | R>;
<R, InErr, OutErr, OutDone, InDone, IA, II, IR, OA, OI, OR>(self: Channel<Chunk<Uint8Array<ArrayBufferLike>>, Chunk<Uint8Array<ArrayBufferLike>>, OutErr, any, OutDone, InDone, R>, options: {
readonly inputSchema: Schema.Schema<IA, II, IR>;
readonly outputSchema: Schema.Schema<OA, OI, OR>;
}): Channel<Chunk<OA>, Chunk<IA>, any, InErr, OutDone, InDone, R | IR | OR>;
}

Constructors

pack

Added in v1.0.0 Source

Signature

declare function pack<IE = never, Done = unknown>(): Channel<Chunk<Uint8Array<ArrayBufferLike>>, Chunk<unknown>, MsgPackError | IE, IE, Done, Done>

packSchema

Added in v1.0.0 Source

Signature

declare function packSchema<A, I, R>(schema: any): <IE = never, Done = unknown>() => Channel<Chunk<Uint8Array<ArrayBufferLike>>, Chunk<A>, any, IE, Done, Done, R>

unpack

Added in v1.0.0 Source

Signature

declare function unpack<IE = never, Done = unknown>(): Channel<Chunk<unknown>, Chunk<Uint8Array<ArrayBufferLike>>, MsgPackError | IE, IE, Done, Done>

unpackSchema

Added in v1.0.0 Source

Signature

declare function unpackSchema<A, I, R>(schema: any): <IE = never, Done = unknown>() => Channel<Chunk<A>, Chunk<Uint8Array<ArrayBufferLike>>, any, IE, Done, Done, R>

Errors

ErrorTypeId

Added in v1.0.0 Source

Signature

declare const ErrorTypeId: unique symbol

ErrorTypeId type

Added in v1.0.0 Source

Signature

type ErrorTypeId = typeof ErrorTypeId

MsgPackError

Added in v1.0.0 Source

Signature

declare class MsgPackError extends YieldableError<this> & {
readonly _tag: "MsgPackError";
} & Readonly<{
readonly cause: unknown;
readonly reason: "Pack" | "Unpack";
}> {
constructor(args: {
readonly cause: unknown;
readonly reason: "Pack" | "Unpack";
});
readonly [ErrorTypeId]: typeof ErrorTypeId;
message: "Pack" | "Unpack";
}

Schemas

schema

Added in v1.0.0 Source

Signature

declare const schema: <S extends Any>(schema: S) => schema<S>

schema interface

Added in v1.0.0 Source

Signature

interface schema<S extends Schema.Schema.Any> extends transformOrFail<Schema<Uint8Array<ArrayBufferLike>>, S> {}