Interface SerDes<ValueT, SerializedT>

A serializer-deserializer

interface SerDes {
    deserialize: ((value) => DeserializationResult<ValueT>);
    isValueType: ((value) => value is ValueT);
    serialize: ((value) => SerializationResult);
    serializedSchema: (() => Schema<SerializedT>);
}

Type Parameters

ValueT
SerializedT extends JsonValue

Index

Properties

deserialize isValueType serialize serializedSchema

Properties

deserialize

deserialize: ((value) => DeserializationResult<ValueT>)

Type declaration

- (value): DeserializationResult<ValueT>
- Deserialize (and validate) a value
  Parameters
  - value: SerializedT
  Returns DeserializationResult<ValueT>

isValueType

isValueType: ((value) => value is ValueT)

Type declaration

- (value): value is ValueT
- Checks if the specified value is the expected type, which is checked before serialization is attempted
  Parameters
  - value: any
  Returns value is ValueT

serialize

serialize: ((value) => SerializationResult)

Type declaration

- (value): SerializationResult
- Serialize (and validate) a value
  Parameters
  - value: ValueT
  Returns SerializationResult

serializedSchema

serializedSchema: (() => Schema<SerializedT>)

Type declaration

- (): Schema<SerializedT>
- A schema for the serialized form, which is checked before deserialization is attempted
  
  Returns Schema<SerializedT>

Generated using TypeDoc