SerializedMessage overview

Added in v1.0.0

Table of contents

• constructors
  • make
• models
  • SerializedMessage (class)
  • SerializedMessage (namespace)
    • Encoded (interface)
• schema
  • schema
• symbols
  • SerializedMessageTypeId
  • SerializedMessageTypeId (type alias)
• utils
  • isSerializedMessage

constructors

make

Construct a new SerializedMessage from its internal string value.

Signature

export declare function make(value: string): SerializedMessage

Added in v1.0.0

models

SerializedMessage (class)

Represents a Message that has been serialized.

Signature

export declare class SerializedMessage

Added in v1.0.0

SerializedMessage (namespace)

Added in v1.0.0

Encoded (interface)

Signature

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

Added in v1.0.0

schema

schema

This is the schema for a value.

Signature

export declare const schema: Schema.Schema<SerializedMessage, SerializedMessage.Encoded>

Added in v1.0.0

symbols

SerializedMessageTypeId

Signature

export declare const SerializedMessageTypeId: typeof SerializedMessageTypeId

Added in v1.0.0

SerializedMessageTypeId (type alias)

Signature

export type SerializedMessageTypeId = typeof SerializedMessageTypeId

Added in v1.0.0

utils

isSerializedMessage

Signature

export declare function isSerializedMessage(value: unknown): value is SerializedMessage

Added in v1.0.0