Function assertEncode

  • Protocol Buffer Encoder with type assertion.

    typia.protobuf.assertEncode() is a combination function of assert and encode.

    Therefore, it converts an input value to a binary data of Protocol Buffer, with type assertion. If input value is not valid, it throws TypeGuardError. Otherwise, there's no problem on the input value, Protocol Buffer binary data would be returned.

    If you can trust input value, or want to perform other type of validation, use below functions intead.

    By the way, you know what? Expression power of Protocol Buffer is not enough strong to fully meet the TypeScript type specs. In such reason, if you put a TypeScript type that is not compatible with Protocol Buffer, this function would throw compilation errors.

    Type Parameters

    • T

      Type of the value input

    Parameters

    Returns Uint8Array

    Encoded binary data

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

  • Protocol Buffer Encoder with type assertion.

    typia.protobuf.assertEncode() is a combination function of assert and encode.

    Therefore, it converts an input value to a binary data of Protocol Buffer, with type assertion. If input value is not valid, it throws TypeGuardError. Otherwise, there's no problem on the input value, Protocol Buffer binary data would be returned.

    If you can trust input value, or want to perform other type of validation, use below functions intead.

    By the way, you know what? Expression power of Protocol Buffer is not enough strong to fully meet the TypeScript type specs. In such reason, if you put a TypeScript type that is not compatible with Protocol Buffer, this function would throw compilation errors.

    Type Parameters

    • T

      Type of the value input

    Parameters

    • input: unknown

      A value to encode

    • OptionalerrorFactory: ((props: TypeGuardError.IProps) => Error)

      Custom error factory. Default is TypeGuardError

    Returns Uint8Array

    Encoded binary data

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