decoder.d.ts 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. /// <reference types="node" />
  2. /// <reference types="node" />
  3. /// <reference types="node" />
  4. import { Transform, TransformCallback, TransformOptions } from 'stream';
  5. export interface SlipDecoderOptions extends TransformOptions {
  6. /** Custom start byte */
  7. START?: number;
  8. /** Custom start escape byte */
  9. ESC_START?: number;
  10. /** custom escape byte */
  11. ESC?: number;
  12. /** custom end byte */
  13. END?: number;
  14. /** custom escape end byte */
  15. ESC_END?: number;
  16. /** custom escape escape byte */
  17. ESC_ESC?: number;
  18. }
  19. /**
  20. * A transform stream that decodes slip encoded data.
  21. * @extends Transform
  22. *
  23. * Runs in O(n) time, stripping out slip encoding and emitting decoded data. Optionally custom slip escape and delimiters can be provided.
  24. */
  25. export declare class SlipDecoder extends Transform {
  26. opts: {
  27. START: number | undefined;
  28. ESC: number;
  29. END: number;
  30. ESC_START: number | undefined;
  31. ESC_END: number;
  32. ESC_ESC: number;
  33. };
  34. buffer: Buffer;
  35. escape: boolean;
  36. start: boolean;
  37. constructor(options?: SlipDecoderOptions);
  38. _transform(chunk: Buffer, encoding: BufferEncoding, cb: TransformCallback): void;
  39. _flush(cb: TransformCallback): void;
  40. }