AsyncCompiler
Hierarchy
- AsyncCompiler
Index
Constructors
Methods
Constructors
Private constructor
- new AsyncCompiler(): AsyncCompiler
-
Throws an error if constructed directly, instead of via initAsyncCompiler.
Returns AsyncCompiler
Methods
compileAsync
- compileAsync(path: string, options?: Options<"async">): Promise<CompileResult>
-
The compileAsync method exposed through an Async Compiler instance while it is active. If this is called after dispose on the Async Compiler instance, an error will be thrown.
During the Async Compiler instance's lifespan, given the same input, this will return an identical result to the compileAsync method exposed at the module root.
Parameters
-
path: string
-
Optionaloptions: Options<"async">
Returns Promise<CompileResult>
-
compileStringAsync
- compileStringAsync(source: string, options?: StringOptions<"async">): Promise<CompileResult>
-
The compileStringAsync method exposed through an Async Compiler instance while it is active. If this is called after dispose on the Async Compiler instance, an error will be thrown.
During the Async Compiler instance's lifespan, given the same input, this will return an identical result to the compileStringAsync method exposed at the module root.
Parameters
-
source: string
-
Optionaloptions: StringOptions<"async">
Returns Promise<CompileResult>
-
dispose
- dispose(): Promise<void>
-
Ends the lifespan of this Async Compiler instance. After this is invoked, all subsequent calls to the Compiler instance's
compileAsyncorcompileStringAsyncmethods will result in an error.Any compilations that are submitted before
disposewill not be cancelled, and will be allowed to settle.After all compilations have been settled and Sass completes any internal task cleanup,
disposewill resolve its promise.Returns Promise<void>
© 2006–2025 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/AsyncCompiler
The result of creating an asynchronous compiler. Returned by initAsyncCompiler.