UNPKG

2.76 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 AsyncCompiler,
7 CompileResult,
8 Compiler,
9 compile,
10 compileAsync,
11 compileString,
12 compileStringAsync,
13 initCompiler,
14 initAsyncCompiler,
15} from './compile';
16export {
17 deprecations,
18 Deprecation,
19 Deprecations,
20 DeprecationOrId,
21 DeprecationStatus,
22 Version,
23} from './deprecations';
24export {Exception} from './exception';
25export {
26 CanonicalizeContext,
27 FileImporter,
28 Importer,
29 ImporterResult,
30 NodePackageImporter,
31} from './importer';
32export {Logger, LoggerWarnOptions, SourceSpan, SourceLocation} from './logger';
33export {
34 CustomFunction,
35 Options,
36 OutputStyle,
37 StringOptions,
38 StringOptionsWithImporter,
39 StringOptionsWithoutImporter,
40 Syntax,
41} from './options';
42export {PromiseOr} from './util/promise_or';
43export {
44 CalculationInterpolation,
45 CalculationOperation,
46 CalculationOperator,
47 CalculationValue,
48 ChannelName,
49 ChannelNameHsl,
50 ChannelNameHwb,
51 ChannelNameLch,
52 ChannelNameLab,
53 ChannelNameRgb,
54 ChannelNameXyz,
55 ColorSpaceHsl,
56 ColorSpaceHwb,
57 ColorSpaceLch,
58 ColorSpaceLab,
59 ColorSpaceRgb,
60 ColorSpaceXyz,
61 GamutMapMethod,
62 HueInterpolationMethod,
63 KnownColorSpace,
64 ListSeparator,
65 PolarColorSpace,
66 RectangularColorSpace,
67 SassArgumentList,
68 SassBoolean,
69 SassCalculation,
70 SassColor,
71 SassFunction,
72 SassList,
73 SassMap,
74 SassMixin,
75 SassNumber,
76 SassString,
77 Value,
78 sassFalse,
79 sassNull,
80 sassTrue,
81} from './value';
82
83// Legacy APIs
84export {LegacyException} from './legacy/exception';
85export {
86 FALSE,
87 LegacyAsyncFunction,
88 LegacyAsyncFunctionDone,
89 LegacyFunction,
90 LegacySyncFunction,
91 LegacyValue,
92 NULL,
93 TRUE,
94 types,
95} from './legacy/function';
96export {
97 LegacyAsyncImporter,
98 LegacyImporter,
99 LegacyImporterResult,
100 LegacyImporterThis,
101 LegacySyncImporter,
102} from './legacy/importer';
103export {
104 LegacySharedOptions,
105 LegacyFileOptions,
106 LegacyStringOptions,
107 LegacyOptions,
108} from './legacy/options';
109export {LegacyPluginThis} from './legacy/plugin_this';
110export {LegacyResult, render, renderSync} from './legacy/render';
111
112/**
113 * Information about the Sass implementation. This always begins with a unique
114 * identifier for the Sass implementation, followed by U+0009 TAB, followed by
115 * its npm package version. Some implementations include additional information
116 * as well, but not in any standardized format.
117 *
118 * * For Dart Sass, the implementation name is `dart-sass`.
119 * * For Node Sass, the implementation name is `node-sass`.
120 * * For the embedded host, the implementation name is `sass-embedded`.
121 */
122export const info: string;