tachyon-drive
    Preparing search index...

    Interface IPersistSerializer<Input, Output, ValidateInput>

    Interface for a serializer that can serialize and deserialize data for persistence.

    v0.7.0

    interface IPersistSerializer<Input, Output, ValidateInput = Input> {
        deserialize: (
            value: Output,
            logger: undefined | ILoggerLike,
        ) => ValidateInput;
        name: string;
        serialize: (data: Input, logger: undefined | ILoggerLike) => Output;
        validator?: (
            data: ValidateInput,
            logger: undefined | ILoggerLike,
        ) => boolean | Promise<boolean>;
    }

    Type Parameters

    • Input

      The type of the data that is serialized and deserialized.

    • Output

      The type of the data that is written to storage.

    • ValidateInput = Input

      The type of the data that is validated.

    Index

    Properties

    deserialize name serialize validator?

    Properties

    deserialize: (value: Output, logger: undefined | ILoggerLike) => ValidateInput

    Deserialize data from store.

    name: string
    serialize: (data: Input, logger: undefined | ILoggerLike) => Output

    Serialize data for store.

    validator?: (
        data: ValidateInput,
        logger: undefined | ILoggerLike,
    ) => boolean | Promise<boolean>

    Optional validator callback to validate the data after hydrate.

    Settings

    Member Visibility

    On This Page

    Properties