RpcSerialization

18 exports Since v1.0.0 Source

Errors

RpcSerializationError

Since v1.0.0

Signature

declare class RpcSerializationError extends YieldableError<this> & {
  readonly _tag: "RpcSerializationError";
} & Readonly<{
  readonly bufferSize: number;
  readonly maxBufferSize: number;
  readonly reason: "BufferSizeExceeded";
}> {
  constructor(args: {
    readonly bufferSize: number;
    readonly maxBufferSize: number;
    readonly reason: "BufferSizeExceeded";
  });
  message: string;
}

Serialization

json

Since v1.0.0

Signature

declare const json: RpcSerialization["Type"]

jsonRpc

Since v1.0.0

Signature

declare function jsonRpc(options?: {
  readonly contentType?: string;
}): any

layerJson

Since v1.0.0

A rpc serialization layer that uses JSON for serialization.

Use this if your protocol supports framing for messages, otherwise use layerNdjson.

Signature

declare const layerJson: Layer.Layer<RpcSerialization>

layerJsonRpc

Since v1.0.0

A rpc serialization layer that uses JSON-RPC for serialization.

Signature

declare function layerJsonRpc(options?: {
  readonly contentType?: string;
}): Layer<RpcSerialization>

layerMsgPack

Since v1.0.0

A rpc serialization layer that uses MessagePack for serialization.

MessagePack has a more compact binary format compared to JSON and NDJSON. It also has better support for binary data.

Signature

declare const layerMsgPack: Layer.Layer<RpcSerialization>

layerMsgPackWith

Since v1.0.0

Signature

declare function layerMsgPackWith(options?: any): Layer<RpcSerialization>

layerNdjson

Since v1.0.0

A rpc serialization layer that uses NDJSON for serialization.

Use this if your protocol does not support framing for messages, otherwise use layerJson.

Signature

declare const layerNdjson: Layer.Layer<RpcSerialization>

layerNdJsonRpc

Since v1.0.0

A rpc serialization layer that uses JSON-RPC for serialization separated by new lines.

Signature

declare function layerNdJsonRpc(options?: {
  readonly contentType?: string;
  readonly maxBufferSize?: number | "unbounded";
}): Layer<RpcSerialization>

layerNdjsonWith

Since v1.0.0

Signature

declare function layerNdjsonWith(options?: StreamOptions): Layer<RpcSerialization>

makeMsgPack

Since v1.0.0

Create a MessagePack serialization with custom msgpackr options.

Signature

declare function makeMsgPack(options?: any): any

makeNdjson

Since v1.0.0

Signature

declare function makeNdjson(options?: StreamOptions): any

msgPack

Since v1.0.0

Signature

declare const msgPack: RpcSerialization["Type"]

ndjson

Since v1.0.0

Signature

declare const ndjson: RpcSerialization["Type"]

ndJsonRpc

Since v1.0.0

Signature

declare function ndJsonRpc(options?: {
  readonly contentType?: string;
  readonly maxBufferSize?: number | "unbounded";
}): any

Parser

interface

Since v1.0.0

Signature

interface Parser {
  readonly decode: (data: string | Uint8Array<ArrayBufferLike>) => readonly Array<unknown>;
  readonly encode: (response: unknown) => string | Uint8Array<ArrayBufferLike> | undefined;
}