Function validateDecode

  • You must configure the generic argument T.

    Protocol Buffer Decoder wity type validation, but not safe.

    typia.protobuf.validateDecode() is a combination function of decode and validate function. Therefore, it decodes a binary data of Protocol Buffer to a TypeScript instance, and performs type validation process. If decoded value is following the type T, it returns the decoded value with IValidation.ISuccess typed instance. Otherwise, it returns IValidation.IFailure value instead with detailed error reasons.

    However, note that, this validation is not always safe. It just performs additional type validation like number & Minimum<7> or string & Format<"uuid"> cases, that are represented by custom tags. Therefore, when using typia.protobuf.validateDecode<T>() function, you have to ensure the type safety by yourself.

    In such type safety reason, I recommend you to use type safe encode functions.

    Parameters

    • input: Uint8Array

      Protobuf Buffer binary data

    Returns never

    Decoded value

    Jeongho Nam - https://github.com/samchon

  • Protocol Buffer Decoder wity type validation, but not safe.

    typia.protobuf.validateDecode() is a combination function of decode and validate function. Therefore, it decodes a binary data of Protocol Buffer to a TypeScript instance, and performs type validation process. If decoded value is following the type T, it returns the decoded value with IValidation.ISuccess typed instance. Otherwise, it returns IValidation.IFailure value instead with detailed error reasons.

    However, note that, this validation is not always safe. It just performs additional type validation like number & Minimum<7> or string & Format<"uuid"> cases, that are represented by custom tags. Therefore, when using typia.protobuf.validateDecode<T>() function, you have to ensure the type safety by yourself.

    In such type safety reason, I recommend you to use type safe encode functions.

    Type Parameters

    • T

      Expected type of decoded value

    Parameters

    • input: Uint8Array

      Protobuf Buffer binary data

    Returns IValidation<Resolved<T>>

    Decoded value

    Jeongho Nam - https://github.com/samchon