Interface SerDes<ValueT, SerializedT>

A serializer-deserializer

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

Type Parameters

ValueT
SerializedT extends JsonValue

Index

Properties

deserialize isValueType serialize serializedSchema

Properties

deserialize

deserialize: (
value: SerializedT,
) => TypeOrPromisedType<DeserializationResult<ValueT>>

Deserialize (and validate) a value

isValueType

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

Checks if the specified value is the expected type, which is checked before serialization is attempted

serialize

serialize: (value: ValueT) => TypeOrPromisedType<SerializationResult>

Serialize (and validate) a value

serializedSchema

serializedSchema: () => Schema<SerializedT>

A schema for the serialized form, which is checked before deserialization is attempted