Message.ts overview

Since v1.0.0

Exports Grouped by Category

incoming
outgoing
serialization / deserialization

incoming

Incoming (type alias)

Signature

type Incoming<R> = IncomingRequest<R> | IncomingEnvelope

Source

Since v1.0.0

IncomingEnvelope (class)

Signature

declare class IncomingEnvelope

Source

Since v1.0.0

IncomingLocal (type alias)

Signature

type IncomingLocal<R> = IncomingRequestLocal<R> | IncomingEnvelope

Source

Since v1.0.0

IncomingRequest (class)

Signature

declare class IncomingRequest<R>

Source

Since v1.0.0

incomingLocalFromOutgoing

Signature

declare const incomingLocalFromOutgoing: <R extends Rpc.Any>(self: Outgoing<R>) => IncomingLocal<R>

Source

Since v1.0.0

outgoing

IncomingRequestLocal (class)

Signature

declare class IncomingRequestLocal<R>

Source

Since v1.0.0

Outgoing (type alias)

Signature

type Outgoing<R> = OutgoingRequest<R> | OutgoingEnvelope

Source

Since v1.0.0

OutgoingEnvelope (class)

Signature

declare class OutgoingEnvelope

Source

Since v1.0.0

OutgoingRequest (class)

Signature

declare class OutgoingRequest<R>

Source

Since v1.0.0

encodedCache (property)

Signature

encodedCache: Envelope.Request.PartialEncoded | undefined

Source

Since v1.0.0

serialization / deserialization

deserializeLocal

Signature

declare const deserializeLocal: <Rpc extends Rpc.Any>(
  self: Outgoing<Rpc>,
  encoded: Envelope.Envelope.PartialEncoded
) => Effect.Effect<IncomingLocal<Rpc>, MalformedMessage>

Source

Since v1.0.0

serialize

Signature

declare const serialize: <Rpc extends Rpc.Any>(
  message: Outgoing<Rpc>
) => Effect.Effect<Envelope.Envelope.PartialEncoded, MalformedMessage>

Source

Since v1.0.0

serializeEnvelope

Signature

declare const serializeEnvelope: <Rpc extends Rpc.Any>(
  message: Outgoing<Rpc>
) => Effect.Effect<Envelope.Envelope.Encoded, MalformedMessage>

Source

Since v1.0.0

serializeRequest

Signature

declare const serializeRequest: <Rpc extends Rpc.Any>(
  self: OutgoingRequest<Rpc>
) => Effect.Effect<Envelope.Request.PartialEncoded, MalformedMessage>

Source

Since v1.0.0