index.d.ts 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. import type { WatchOptions } from 'chokidar'
  2. export type NodemonEventHandler =
  3. | 'start'
  4. | 'crash'
  5. | 'exit'
  6. | 'quit'
  7. | 'restart'
  8. | 'config:update'
  9. | 'log'
  10. | 'readable'
  11. | 'stdout'
  12. | 'stderr';
  13. export type NodemonEventListener = {
  14. on(event: 'start' | 'crash' | 'readable', listener: () => void): Nodemon;
  15. on(event: 'log', listener: (e: NodemonEventLog) => void): Nodemon;
  16. on(event: 'stdout' | 'stderr', listener: (e: string) => void): Nodemon;
  17. on(event: 'restart', listener: (e?: NodemonEventRestart) => void): Nodemon;
  18. on(event: 'quit', listener: (e?: NodemonEventQuit) => void): Nodemon;
  19. on(event: 'exit', listener: (e?: number) => void): Nodemon;
  20. on(event: 'config:update', listener: (e?: NodemonEventConfig) => void): Nodemon;
  21. };
  22. export type NodemonEventLog = {
  23. /**
  24. - detail: what you get with nodemon --verbose.
  25. - status: subprocess starting, restarting.
  26. - fail: is the subprocess crashing.
  27. - error: is a nodemon system error.
  28. */
  29. type: 'detail' | 'log' | 'status' | 'error' | 'fail';
  30. /** the plain text message */
  31. message: string;
  32. /** contains the terminal escape codes to add colour, plus the "[nodemon]" prefix */
  33. colour: string;
  34. };
  35. export interface NodemonEventRestart {
  36. matched?: {
  37. result: string[];
  38. total: number;
  39. };
  40. }
  41. export type NodemonEventQuit = 143 | 130;
  42. export type NodemonEventConfig = {
  43. run: boolean;
  44. system: {
  45. cwd: string;
  46. };
  47. required: boolean;
  48. dirs: string[];
  49. timeout: number;
  50. options: NodemonConfig;
  51. lastStarted: number;
  52. loaded: string[];
  53. load: (settings: NodemonSettings, ready: (config: NodemonEventConfig) => void) => void;
  54. reset: () => void;
  55. };
  56. export interface NodemonExecOptions {
  57. script: string;
  58. scriptPosition?: number;
  59. args?: string[];
  60. ext?: string; // "js,mjs" etc (should really support an array of strings, but I don't think it does right now)
  61. exec?: string; // node, python, etc
  62. execArgs?: string[]; // args passed to node, etc,
  63. nodeArgs?: string[]; // args passed to node, etc,
  64. }
  65. export interface NodemonConfig {
  66. /** restartable defaults to "rs" as a string the user enters */
  67. restartable?: false | string;
  68. colours?: boolean;
  69. execMap?: { [key: string]: string };
  70. ignoreRoot?: string[];
  71. watch?: string[];
  72. ignore?: string[];
  73. stdin?: boolean;
  74. runOnChangeOnly?: boolean;
  75. verbose?: boolean;
  76. signal?: string;
  77. stdout?: boolean;
  78. watchOptions?: WatchOptions;
  79. help?: string;
  80. version?: boolean;
  81. cwd?: string;
  82. dump?: boolean;
  83. delay?: number;
  84. monitor?: string[];
  85. spawn?: boolean;
  86. noUpdateNotifier?: boolean;
  87. legacyWatch?: boolean;
  88. pollingInterval?: number;
  89. /** @deprecated as this is "on" by default */
  90. js?: boolean;
  91. quiet?: boolean;
  92. configFile?: string;
  93. exitCrash?: boolean;
  94. execOptions?: NodemonExecOptions;
  95. }
  96. export interface NodemonSettings extends NodemonConfig, NodemonExecOptions {
  97. events?: Record<string, string>;
  98. env?: Record<string, string>;
  99. }
  100. export type Nodemon = {
  101. (settings: NodemonSettings): Nodemon;
  102. removeAllListeners(event: NodemonEventHandler): Nodemon;
  103. emit(type: NodemonEventHandler, event?: any): Nodemon;
  104. reset(callback: Function): Nodemon;
  105. restart(): Nodemon;
  106. config: NodemonSettings;
  107. } & NodemonEventListener & {
  108. [K in keyof NodemonEventListener as "addListener"]: NodemonEventListener[K];
  109. } & {
  110. [K in keyof NodemonEventListener as "once"]: NodemonEventListener[K];
  111. };
  112. declare const nodemon: Nodemon;
  113. export = nodemon;