Interface ISerializer

Serializer contract for converting messages to/from string payloads.

Type Param: T

The payload type being serialized

Since

0.1.0

interface ISerializer {
deserialize<T = unknown>(payload: string): T;
serialize<T>(value: T): string;
}

Implemented by

JsonSerializer

Index

Methods

deserialize serialize

Methods

deserialize

deserialize<T = unknown>(payload: string): T
Deserializes a string payload to a value.
Type Parameters
- T = unknown
  The expected payload type
Parameters
- payload: string
  The string payload to deserialize
Returns T
The deserialized value

Since
0.1.0
- Defined in packages/messaging-plugin/src/serializers/serializer.ts:32

serialize

serialize<T>(value: T): string
Serializes a value to a string payload.
Type Parameters
- T
  The payload type
Parameters
- value: T
  The value to serialize
Returns string
The serialized string

Since
0.1.0
- Defined in packages/messaging-plugin/src/serializers/serializer.ts:22