index.d.ts 1009 B

123456789101112131415161718192021222324
  1. /// <reference types="node" />
  2. /// <reference types="node" />
  3. /// <reference types="node" />
  4. import { Transform, TransformCallback, TransformOptions } from 'stream';
  5. export interface DelimiterOptions extends TransformOptions {
  6. /** The delimiter on which to split incoming data. */
  7. delimiter: string | Buffer | number[];
  8. /** Should the delimiter be included at the end of data. Defaults to `false` */
  9. includeDelimiter?: boolean;
  10. }
  11. /**
  12. * A transform stream that emits data each time a byte sequence is received.
  13. * @extends Transform
  14. *
  15. * To use the `Delimiter` parser, provide a delimiter as a string, buffer, or array of bytes. Runs in O(n) time.
  16. */
  17. export declare class DelimiterParser extends Transform {
  18. includeDelimiter: boolean;
  19. delimiter: Buffer;
  20. buffer: Buffer;
  21. constructor({ delimiter, includeDelimiter, ...options }: DelimiterOptions);
  22. _transform(chunk: Buffer, encoding: BufferEncoding, cb: TransformCallback): void;
  23. _flush(cb: TransformCallback): void;
  24. }