index.d.ts 878 B

1234567891011121314151617181920
  1. /// <reference types="node" />
  2. /// <reference types="node" />
  3. /// <reference types="node" />
  4. import { DelimiterParser } from '@serialport/parser-delimiter';
  5. import { TransformOptions } from 'stream';
  6. export interface ReadlineOptions extends TransformOptions {
  7. /** delimiter to use defaults to \n */
  8. delimiter?: string | Buffer | number[];
  9. /** include the delimiter at the end of the packet defaults to false */
  10. includeDelimiter?: boolean;
  11. /** Defaults to utf8 */
  12. encoding?: BufferEncoding;
  13. }
  14. /**
  15. * A transform stream that emits data after a newline delimiter is received.
  16. * @summary To use the `Readline` parser, provide a delimiter (defaults to `\n`). Data is emitted as string controllable by the `encoding` option (defaults to `utf8`).
  17. */
  18. export declare class ReadlineParser extends DelimiterParser {
  19. constructor(options?: ReadlineOptions);
  20. }