Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

types: overload build definitions #561

Merged
merged 2 commits into from
Nov 25, 2020
Merged

types: overload build definitions #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58b1628
types: overload `build` definitions
lukeed Nov 25, 2020
1c9eabd
add type checking tests
evanw Nov 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,16 @@ export interface OutputFile {
text: string; // "contents" as text
}

export type BuildInvalidate = () => Promise<BuildIncremental>;

export interface BuildIncremental extends BuildResult {
rebuild: BuildInvalidate & { dispose(): void };
}

export interface BuildResult {
warnings: Message[];
outputFiles?: OutputFile[]; // Only when "write: false"
rebuild?: (() => Promise<BuildResult>) & { dispose(): void }; // Only when "incremental" is true
rebuild?: BuildInvalidate; // Only when "incremental" is true
}

export interface BuildFailure extends Error {
Expand Down Expand Up @@ -225,6 +231,8 @@ export interface Metadata {
}

export interface Service {
build(options: BuildOptions & { write: false }): Promise<BuildResult & { outputFiles: OutputFile[] }>;
build(options: BuildOptions & { incremental: true }): Promise<BuildIncremental>;
build(options: BuildOptions): Promise<BuildResult>;
serve(serveOptions: ServeOptions, buildOptions: BuildOptions): Promise<ServeResult>;
transform(input: string, options?: TransformOptions): Promise<TransformResult>;
Expand All @@ -240,6 +248,8 @@ export interface Service {
//
// Works in node: yes
// Works in browser: no
export declare function build(options: BuildOptions & { write: false }): Promise<BuildResult & { outputFiles: OutputFile[] }>;
export declare function build(options: BuildOptions & { incremental: true }): Promise<BuildIncremental>;
export declare function build(options: BuildOptions): Promise<BuildResult>;

// This function is similar to "build" but it serves the resulting files over
Expand All @@ -262,6 +272,7 @@ export declare function transform(input: string, options?: TransformOptions): Pr
//
// Works in node: yes
// Works in browser: no
export declare function buildSync(options: BuildOptions & { write: false }): BuildResult & { outputFiles: OutputFile[] };
export declare function buildSync(options: BuildOptions): BuildResult;

// A synchronous version of "transform".
Expand Down
16 changes: 16 additions & 0 deletions scripts/ts-type-tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,22 @@ const tests = {
esbuild.startService().then(service => service.transform(''))
esbuild.startService().then(service => service.transform('', {}))
`,
writeFalseOutputFiles: `
import * as esbuild from 'esbuild'
esbuild.buildSync({ write: false }).outputFiles[0]
esbuild.build({ write: false }).then(result => result.outputFiles[0])
esbuild.startService().then(service => service.build({ write: false }).then(result => result.outputFiles[0]))
`,
incrementalTrueRebuild: `
import * as esbuild from 'esbuild'
esbuild.build({ incremental: true }).then(result =>
result.rebuild().then(result =>
result.rebuild()))
esbuild.startService().then(service =>
service.build({ incremental: true }).then(result =>
result.rebuild().then(result =>
result.rebuild())))
`,
allOptionsTransform: `
export {}
import {transform} from 'esbuild'
Expand Down