Skip to content

Function: transform()

Transpile a JavaScript or TypeScript into a target ECMAScript version, asynchronously.

Note: This function can be slower than transformSync due to the overhead of spawning a thread.

Parameters

filename

string

The name of the file being transformed. If this is a relative path, consider setting the TransformOptions#cwd option.

sourceText

string

The source code to transform.

options?

The transform options including tsconfig and inputMap. See TransformOptions for more information.

TransformOptions | null

cache?

Optional tsconfig cache for reusing resolved tsconfig across multiple transforms. Only used when options.tsconfig is true.

TsconfigCache | null

Returns

Promise<TransformResult>

a promise that resolves to an object containing the transformed code, source maps, and any errors that occurred during parsing or transformation.