SerializedEnvelope overview

Added in v1.0.0

Table of contents

• constructors
  • make
• models
  • SerializedEnvelope (class)
  • SerializedEnvelope (namespace)
    • Encoded (interface)
• schema
  • schema
• symbols
  • SerializedEnvelopeTypeId
  • SerializedEnvelopeTypeId (type alias)
• utils
  • isSerializedEnvelope

constructors

make

Construct a new SerializedEnvelope

Signature

export declare function make(
  recipientAddress: RecipientAddress.RecipientAddress,
  messageId: string,
  body: SerializedMessage.SerializedMessage
): SerializedEnvelope

Added in v1.0.0

models

SerializedEnvelope (class)

A SerializedEnvelope is the message that goes over the wire between pods. Inside the Envelope, you have the encoded messages, plus some informations on where it should be routed to.

Signature

export declare class SerializedEnvelope

Added in v1.0.0

SerializedEnvelope (namespace)

Added in v1.0.0

Encoded (interface)

Signature

export interface Encoded extends Schema.Schema.Encoded<typeof SerializedEnvelope> {}

Added in v1.0.0

schema

schema

This is the schema for a value.

Signature

export declare const schema: Schema.Schema<SerializedEnvelope, SerializedEnvelope.Encoded, never>

Added in v1.0.0

symbols

SerializedEnvelopeTypeId

Signature

export declare const SerializedEnvelopeTypeId: typeof SerializedEnvelopeTypeId

Added in v1.0.0

SerializedEnvelopeTypeId (type alias)

Signature

export type SerializedEnvelopeTypeId = typeof SerializedEnvelopeTypeId

Added in v1.0.0

utils

isSerializedEnvelope

Ensures that the given value is a SerializedEnvelope.

Signature

export declare function isSerializedEnvelope(value: unknown): value is SerializedEnvelope

Added in v1.0.0