index.d.ts 1.1 KB

1234567891011121314151617181920212223242526272829
  1. declare function isUnsafePort(port: number): boolean;
  2. declare function isSafePort(port: number): boolean;
  3. interface GetPortOptions {
  4. name: string;
  5. random: boolean;
  6. port: number;
  7. ports: number[];
  8. portRange: [from: number, to: number];
  9. alternativePortRange: [from: number, to: number];
  10. host: string;
  11. memoDir: string;
  12. memoName: string;
  13. verbose?: boolean;
  14. }
  15. declare type GetPortInput = Partial<GetPortOptions> | number | string;
  16. declare type HostAddress = undefined | string;
  17. declare type PortNumber = number;
  18. declare function getPort(config?: GetPortInput): Promise<PortNumber>;
  19. declare function getRandomPort(host?: HostAddress): Promise<number>;
  20. interface WaitForPortOptions {
  21. host?: HostAddress;
  22. delay?: number;
  23. retries?: number;
  24. }
  25. declare function waitForPort(port: PortNumber, opts?: WaitForPortOptions): Promise<void>;
  26. declare function checkPort(port: PortNumber, host?: HostAddress | HostAddress[], _verbose?: boolean): Promise<PortNumber | false>;
  27. export { GetPortInput, GetPortOptions, HostAddress, PortNumber, WaitForPortOptions, checkPort, getPort, getRandomPort, isSafePort, isUnsafePort, waitForPort };