types: more build overload definitions (#1911)

evanw · Jan 6, 2022 · 86e6278 · 86e6278
1 parent 5c64b40
commit 86e6278
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/lib/shared/types.ts b/lib/shared/types.ts
@@ -449,7 +449,9 @@ export interface AnalyzeMetafileOptions {
  * Documentation: https://esbuild.github.io/api/#build-api
  */
 export declare function build(options: BuildOptions & { write: false }): Promise<BuildResult & { outputFiles: OutputFile[] }>;
+export declare function build(options: BuildOptions & { incremental: true, metafile: true }): Promise<BuildIncremental & { metafile: Metafile }>;
 export declare function build(options: BuildOptions & { incremental: true }): Promise<BuildIncremental>;
+export declare function build(options: BuildOptions & { metafile: true }): Promise<BuildResult & { metafile: Metafile }>;
 export declare function build(options: BuildOptions): Promise<BuildResult>;
 
 /**

diff --git a/scripts/ts-type-tests.js b/scripts/ts-type-tests.js
@@ -60,6 +60,21 @@ const tests = {
       result.rebuild.dispose()
     }
   `,
+  metafileTrue: `
+    import {build, analyzeMetafile} from 'esbuild';
+    build({ metafile: true }).then(result => {
+      analyzeMetafile(result.metafile)
+    })
+  `,
+  incrementalAndMetafileTrue: `
+    import {build, analyzeMetafile} from 'esbuild';
+    build({
+      incremental: true,
+      metafile: true,
+    }).then(result => {
+      analyzeMetafile(result.metafile)
+    })
+  `,
   ifRebuild: `
     import * as esbuild from 'esbuild'
     let options: any