tapable.d.ts 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. type FixedSizeArray<T extends number, U> = T extends 0
  2. ? void[]
  3. : ReadonlyArray<U> & {
  4. 0: U;
  5. length: T;
  6. };
  7. type Measure<T extends number> = T extends 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
  8. ? T
  9. : never;
  10. type Append<T extends any[], U> = {
  11. 0: [U];
  12. 1: [T[0], U];
  13. 2: [T[0], T[1], U];
  14. 3: [T[0], T[1], T[2], U];
  15. 4: [T[0], T[1], T[2], T[3], U];
  16. 5: [T[0], T[1], T[2], T[3], T[4], U];
  17. 6: [T[0], T[1], T[2], T[3], T[4], T[5], U];
  18. 7: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], U];
  19. 8: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], U];
  20. }[Measure<T["length"]>];
  21. type AsArray<T> = T extends any[] ? T : [T];
  22. declare class UnsetAdditionalOptions {
  23. _UnsetAdditionalOptions: true;
  24. }
  25. type IfSet<X> = X extends UnsetAdditionalOptions ? {} : X;
  26. type Callback<E, T> = (error: E | null, result?: T) => void;
  27. type InnerCallback<E, T> = (error?: E | null | false, result?: T) => void;
  28. type FullTap = Tap & {
  29. type: "sync" | "async" | "promise";
  30. fn: Function;
  31. };
  32. type Tap = TapOptions & {
  33. name: string;
  34. };
  35. type TapOptions = {
  36. before?: string;
  37. stage?: number;
  38. };
  39. interface HookInterceptor<T, R, AdditionalOptions = UnsetAdditionalOptions> {
  40. name?: string;
  41. tap?: (tap: FullTap & IfSet<AdditionalOptions>) => void;
  42. call?: (...args: any[]) => void;
  43. loop?: (...args: any[]) => void;
  44. error?: (err: Error) => void;
  45. result?: (result: R) => void;
  46. done?: () => void;
  47. register?: (
  48. tap: FullTap & IfSet<AdditionalOptions>
  49. ) => FullTap & IfSet<AdditionalOptions>;
  50. }
  51. type ArgumentNames<T extends any[]> = FixedSizeArray<T["length"], string>;
  52. declare class Hook<T, R, AdditionalOptions = UnsetAdditionalOptions> {
  53. constructor(args?: ArgumentNames<AsArray<T>>, name?: string);
  54. name: string | undefined;
  55. interceptors: HookInterceptor<T, R, AdditionalOptions>[];
  56. taps: FullTap[];
  57. intercept(interceptor: HookInterceptor<T, R, AdditionalOptions>): void;
  58. isUsed(): boolean;
  59. callAsync(...args: Append<AsArray<T>, Callback<Error, R>>): void;
  60. promise(...args: AsArray<T>): Promise<R>;
  61. tap(
  62. options: string | (Tap & IfSet<AdditionalOptions>),
  63. fn: (...args: AsArray<T>) => R
  64. ): void;
  65. withOptions(
  66. options: TapOptions & IfSet<AdditionalOptions>
  67. ): Omit<this, "call" | "callAsync" | "promise">;
  68. }
  69. export class SyncHook<
  70. T,
  71. R = void,
  72. AdditionalOptions = UnsetAdditionalOptions
  73. > extends Hook<T, R, AdditionalOptions> {
  74. call(...args: AsArray<T>): R;
  75. }
  76. export class SyncBailHook<
  77. T,
  78. R,
  79. AdditionalOptions = UnsetAdditionalOptions
  80. > extends SyncHook<T, R, AdditionalOptions> {}
  81. export class SyncLoopHook<
  82. T,
  83. AdditionalOptions = UnsetAdditionalOptions
  84. > extends SyncHook<T, void, AdditionalOptions> {}
  85. export class SyncWaterfallHook<
  86. T,
  87. AdditionalOptions = UnsetAdditionalOptions
  88. > extends SyncHook<T, AsArray<T>[0], AdditionalOptions> {}
  89. declare class AsyncHook<
  90. T,
  91. R,
  92. AdditionalOptions = UnsetAdditionalOptions
  93. > extends Hook<T, R, AdditionalOptions> {
  94. tapAsync(
  95. options: string | (Tap & IfSet<AdditionalOptions>),
  96. fn: (...args: Append<AsArray<T>, InnerCallback<Error, R>>) => void
  97. ): void;
  98. tapPromise(
  99. options: string | (Tap & IfSet<AdditionalOptions>),
  100. fn: (...args: AsArray<T>) => Promise<R>
  101. ): void;
  102. }
  103. export class AsyncParallelHook<
  104. T,
  105. AdditionalOptions = UnsetAdditionalOptions
  106. > extends AsyncHook<T, void, AdditionalOptions> {}
  107. export class AsyncParallelBailHook<
  108. T,
  109. R,
  110. AdditionalOptions = UnsetAdditionalOptions
  111. > extends AsyncHook<T, R, AdditionalOptions> {}
  112. export class AsyncSeriesHook<
  113. T,
  114. AdditionalOptions = UnsetAdditionalOptions
  115. > extends AsyncHook<T, void, AdditionalOptions> {}
  116. export class AsyncSeriesBailHook<
  117. T,
  118. R,
  119. AdditionalOptions = UnsetAdditionalOptions
  120. > extends AsyncHook<T, R, AdditionalOptions> {}
  121. export class AsyncSeriesLoopHook<
  122. T,
  123. AdditionalOptions = UnsetAdditionalOptions
  124. > extends AsyncHook<T, void, AdditionalOptions> {}
  125. export class AsyncSeriesWaterfallHook<
  126. T,
  127. AdditionalOptions = UnsetAdditionalOptions
  128. > extends AsyncHook<T, AsArray<T>[0], AdditionalOptions> {}
  129. type HookFactory<H> = (key: any, hook?: H) => H;
  130. interface HookMapInterceptor<H> {
  131. factory?: HookFactory<H>;
  132. }
  133. export class HookMap<H> {
  134. constructor(factory: HookFactory<H>, name?: string);
  135. name: string | undefined;
  136. get(key: any): H | undefined;
  137. for(key: any): H;
  138. intercept(interceptor: HookMapInterceptor<H>): void;
  139. }
  140. export class MultiHook<H> {
  141. constructor(hooks: H[], name?: string);
  142. name: string | undefined;
  143. tap(options: string | Tap, fn?: Function): void;
  144. tapAsync(options: string | Tap, fn?: Function): void;
  145. tapPromise(options: string | Tap, fn?: Function): void;
  146. }