index.d.ts 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. /// <reference types="node" />
  2. import { BindingInterface } from '@serialport/bindings-interface';
  3. import { BindingPortInterface } from '@serialport/bindings-interface';
  4. import { OpenOptions } from '@serialport/bindings-interface';
  5. import { PortInfo } from '@serialport/bindings-interface';
  6. import { PortStatus } from '@serialport/bindings-interface';
  7. import { SetOptions } from '@serialport/bindings-interface';
  8. import { UpdateOptions } from '@serialport/bindings-interface';
  9. export declare class CanceledError extends Error {
  10. canceled: true;
  11. constructor(message: string);
  12. }
  13. export declare interface CreatePortOptions {
  14. echo?: boolean;
  15. record?: boolean;
  16. readyData?: Buffer;
  17. maxReadSize?: number;
  18. manufacturer?: string;
  19. vendorId?: string;
  20. productId?: string;
  21. }
  22. export declare const MockBinding: MockBindingInterface;
  23. export declare interface MockBindingInterface extends BindingInterface<MockPortBinding> {
  24. reset(): void;
  25. createPort(path: string, opt?: CreatePortOptions): void;
  26. }
  27. /**
  28. * Mock bindings for pretend serialport access
  29. */
  30. export declare class MockPortBinding implements BindingPortInterface {
  31. readonly openOptions: Required<OpenOptions>;
  32. readonly port: MockPortInternal;
  33. private pendingRead;
  34. lastWrite: null | Buffer;
  35. recording: Buffer;
  36. writeOperation: null | Promise<void>;
  37. isOpen: boolean;
  38. serialNumber?: string;
  39. constructor(port: MockPortInternal, openOptions: Required<OpenOptions>);
  40. emitData(data: Buffer | string): void;
  41. close(): Promise<void>;
  42. read(buffer: Buffer, offset: number, length: number): Promise<{
  43. buffer: Buffer;
  44. bytesRead: number;
  45. }>;
  46. write(buffer: Buffer): Promise<void>;
  47. update(options: UpdateOptions): Promise<void>;
  48. set(options: SetOptions): Promise<void>;
  49. get(): Promise<PortStatus>;
  50. getBaudRate(): Promise<{
  51. baudRate: number;
  52. }>;
  53. flush(): Promise<void>;
  54. drain(): Promise<void>;
  55. }
  56. export declare interface MockPortInternal {
  57. data: Buffer;
  58. echo: boolean;
  59. record: boolean;
  60. info: PortInfo;
  61. maxReadSize: number;
  62. readyData?: Buffer;
  63. openOpt?: OpenOptions;
  64. }
  65. export { }