Class DelimiterCodec

constructor

• new DelimiterCodec(
      delimiter: Uint8Array,
      options?: DelimiterCodecOptions,
  ): DelimiterCodec

• Parameters

  • delimiter: Uint8Array

    delimiter to use
  • Optionaloptions: DelimiterCodecOptions

    options

  Returns DelimiterCodec

Readonlydelimiter

Optional Readonlyoptions

decode

• decode(buf: Bytes, eof: boolean): null | Uint8Array

• Decode a frame from a buffer

  Important implementation notice: When returning byte arrays, make sure that the returned array is not a view into the original buffer, as the underlying buffer may get invalidated

  Parameters

  • buf: Bytes
  • eof: boolean

  Returns null | Uint8Array

encode

• encode(data: Uint8Array, into: ISyncWritable): void

• Encode a frame into a writable stream

  Parameters

  • data: Uint8Array
  • into: ISyncWritable

  Returns void

reset

• reset(): void

• Reset the encoder, should it have any internal state

  Returns void