Class Codec<Encodable, Decoded>

constructor

• new Codec<Encodable, Decoded = Encodable>(
      encode: (encodable: Encodable) => Bytes,
      decode: (
          decodable: BytesLike,
          config?: { isExtraFieldIgnored?: boolean },
      ) => Decoded,
      byteLength?: number,
  ): Codec<Encodable, Decoded>

  Type Parameters

  • Encodable
  • Decoded = Encodable

  Parameters

  • encode: (encodable: Encodable) => Bytes
  • decode: (decodable: BytesLike, config?: { isExtraFieldIgnored?: boolean }) => Decoded
  • OptionalbyteLength: number

  Returns Codec<Encodable, Decoded>

Readonlyencode

Readonlydecode

Optional ReadonlybyteLength

encodeOr

• encodeOr<T>(encodable: Encodable, fallback: T): Bytes | T

  Type Parameters

  • T

  Parameters

  • encodable: Encodable
  • fallback: T

  Returns Bytes | T

decodeOr

• decodeOr<T>(
      decodable: BytesLike,
      fallback: T,
      config?: { isExtraFieldIgnored?: boolean },
  ): Decoded | T

  Type Parameters

  • T

  Parameters

  • decodable: BytesLike
  • fallback: T
  • Optionalconfig: { isExtraFieldIgnored?: boolean }

  Returns Decoded | T

Staticfrom

• from<Encodable, Decoded = Encodable>(
      __namedParameters: CodecLike<Encodable, Decoded>,
  ): Codec<Encodable, Decoded>

  Type Parameters

  • Encodable
  • Decoded = Encodable

  Parameters

  • __namedParameters: CodecLike<Encodable, Decoded>

  Returns Codec<Encodable, Decoded>

map

• map<NewEncodable = Encodable, NewDecoded = Decoded>(
      __namedParameters: {
          inMap?: (encodable: NewEncodable) => Encodable;
          outMap?: (decoded: Decoded) => NewDecoded;
      },
  ): Codec<NewEncodable, NewDecoded>

  Type Parameters

  • NewEncodable = Encodable
  • NewDecoded = Decoded

  Parameters

  • __namedParameters: {
        inMap?: (encodable: NewEncodable) => Encodable;
        outMap?: (decoded: Decoded) => NewDecoded;
    }

  Returns Codec<NewEncodable, NewDecoded>

mapIn

• mapIn<NewEncodable>(
      map: (encodable: NewEncodable) => Encodable,
  ): Codec<NewEncodable, Decoded>

  Type Parameters

  • NewEncodable

  Parameters

  • map: (encodable: NewEncodable) => Encodable

  Returns Codec<NewEncodable, Decoded>

mapOut

• mapOut<NewDecoded>(
      map: (decoded: Decoded) => NewDecoded,
  ): Codec<Encodable, NewDecoded>

  Type Parameters

  • NewDecoded

  Parameters

  • map: (decoded: Decoded) => NewDecoded

  Returns Codec<Encodable, NewDecoded>