index.d.ts 888 B

1234567891011121314151617181920
  1. /// <reference types="node" />
  2. /// <reference types="node" />
  3. /// <reference types="node" />
  4. import { Transform, TransformCallback, TransformOptions } from 'stream';
  5. export interface ReadyParserOptions extends TransformOptions {
  6. /** delimiter to use to detect the input is ready */
  7. delimiter: string | Buffer | number[];
  8. }
  9. /**
  10. * A transform stream that waits for a sequence of "ready" bytes before emitting a ready event and emitting data events
  11. *
  12. * To use the `Ready` parser provide a byte start sequence. After the bytes have been received a ready event is fired and data events are passed through.
  13. */
  14. export declare class ReadyParser extends Transform {
  15. delimiter: Buffer;
  16. readOffset: number;
  17. ready: boolean;
  18. constructor({ delimiter, ...options }: ReadyParserOptions);
  19. _transform(chunk: Buffer, encoding: BufferEncoding, cb: TransformCallback): void;
  20. }