Class YDecoder

constructor

• new YDecoder(payloadOnly?: boolean): YDecoder

  Creates a new yEnc decoder.

  Parameters

  • payloadOnly: boolean = false

    If true, decoding begins immediately rather than after finding a =ybegin line.

  Returns YDecoder

Readonlyencoding

checksum

• get checksum(): number

  The current checksum.

  Returns number

clone

• clone(): MimeDecoder

  Creates a new yEnc decoder with exactly the same state as this decoder.

  Returns MimeDecoder

  A new decoder with identical state.

estimateOutputLength

• estimateOutputLength(inputLength: number): number

  Estimates the number of bytes needed to decode the specified number of input bytes.

  Parameters

  • inputLength: number

    The input length.

  Returns number

  The estimated output length.

decode

• decode(
      input: Uint8Array,
      startIndex: number,
      length: number,
      output: Uint8Array,
  ): number

  Decodes the specified input into the output buffer.

  Parameters

  • input: Uint8Array

    The input buffer.

  • startIndex: number

    The starting index of the input buffer.

  • length: number

    The length of the input range.

  • output: Uint8Array

    The output buffer.

  Returns number

  The number of bytes written to the output buffer.

  Throws

  The input range is invalid or the output buffer is too small.

reset

• reset(): void

  Resets the state of the decoder.

  Returns void