UNPKG

2.02 kBTypeScriptView Raw
1// This is a mirror of the JS API definitions in `spec/js-api`, but with comments
2// written to provide user-facing documentation rather than to specify behavior for
3// implementations.
4
5export {
6 CompileResult,
7 compile,
8 compileAsync,
9 compileString,
10 compileStringAsync,
11} from './compile';
12export {Exception} from './exception';
13export {FileImporter, Importer, ImporterResult} from './importer';
14export {Logger, SourceSpan, SourceLocation} from './logger';
15export {
16 CustomFunction,
17 Options,
18 OutputStyle,
19 StringOptions,
20 StringOptionsWithImporter,
21 StringOptionsWithoutImporter,
22 Syntax,
23} from './options';
24export {PromiseOr} from './util/promise_or';
25export {
26 ListSeparator,
27 SassArgumentList,
28 SassBoolean,
29 SassColor,
30 SassFunction,
31 SassList,
32 SassMap,
33 SassNumber,
34 SassString,
35 Value,
36 sassFalse,
37 sassNull,
38 sassTrue,
39} from './value';
40
41// Legacy APIs
42export {LegacyException} from './legacy/exception';
43export {
44 FALSE,
45 LegacyAsyncFunction,
46 LegacyAsyncFunctionDone,
47 LegacyFunction,
48 LegacySyncFunction,
49 LegacyValue,
50 NULL,
51 TRUE,
52 types,
53} from './legacy/function';
54export {
55 LegacyAsyncImporter,
56 LegacyImporter,
57 LegacyImporterResult,
58 LegacyImporterThis,
59 LegacySyncImporter,
60} from './legacy/importer';
61export {
62 LegacySharedOptions,
63 LegacyFileOptions,
64 LegacyStringOptions,
65 LegacyOptions,
66} from './legacy/options';
67export {LegacyPluginThis} from './legacy/plugin_this';
68export {LegacyResult, render, renderSync} from './legacy/render';
69
70/**
71 * Information about the Sass implementation. This always begins with a unique
72 * identifier for the Sass implementation, followed by U+0009 TAB, followed by
73 * its npm package version. Some implementations include additional information
74 * as well, but not in any standardized format.
75 *
76 * * For Dart Sass, the implementation name is `dart-sass`.
77 * * For Node Sass, the implementation name is `node-sass`.
78 * * For the embedded host, the implementation name is `sass-embedded`.
79 */
80export const info: string;