sass-embedded 1.0.0-beta.5 → 1.0.0-beta.7

package/dist/types/index.d.ts

@@ -0,0 +1,76 @@
+// This is a mirror of the JS API definitions in `spec/js-api`, but with comments
+// written to provide user-facing documentation rather than to specify behavior for
+// implementations.
+
+export {
+  CompileResult,
+  compile,
+  compileAsync,
+  compileString,
+  compileStringAsync,
+} from './compile';
+export {Exception} from './exception';
+export {FileImporter, Importer, ImporterResult} from './importer';
+export {Logger, SourceSpan, SourceLocation} from './logger';
+export {
+  CustomFunction,
+  Options,
+  OutputStyle,
+  StringOptions,
+  StringOptionsWithImporter,
+  StringOptionsWithoutImporter,
+  Syntax,
+} from './options';
+export {PromiseOr} from './util/promise_or';
+export {
+  ListSeparator,
+  SassArgumentList,
+  SassBoolean,
+  SassColor,
+  SassFunction,
+  SassList,
+  SassMap,
+  SassNumber,
+  SassString,
+  Value,
+  sassFalse,
+  sassNull,
+  sassTrue,
+} from './value';
+
+// Legacy APIs
+export {LegacyException} from './legacy/exception';
+export {
+  LegacyAsyncFunction,
+  LegacySyncFunction,
+  LegacyFunction,
+  LegacyValue,
+  types,
+} from './legacy/function';
+export {
+  LegacyAsyncImporter,
+  LegacyImporter,
+  LegacyImporterResult,
+  LegacyImporterThis,
+  LegacySyncImporter,
+} from './legacy/importer';
+export {
+  LegacySharedOptions,
+  LegacyFileOptions,
+  LegacyStringOptions,
+  LegacyOptions,
+} from './legacy/options';
+export {LegacyPluginThis} from './legacy/plugin_this';
+export {LegacyResult, render, renderSync} from './legacy/render';
+
+/**
+ * Information about the Sass implementation. This always begins with a unique
+ * identifier for the Sass implementation, followed by U+0009 TAB, followed by
+ * its npm package version. Some implementations include additional information
+ * as well, but not in any standardized format.
+ *
+ * * For Dart Sass, the implementation name is `dart-sass`.
+ * * For Node Sass, the implementation name is `node-sass`.
+ * * For the embedded host, the implementation name is `sass-embedded`.
+ */
+export const info: string;

package/dist/types/legacy/exception.d.ts

@@ -0,0 +1,54 @@
+/**
+ * The exception type thrown by [[renderSync]] and passed as the error to
+ * [[render]]'s callback.
+ *
+ * @category Legacy
+ * @deprecated This is only thrown by the legacy [[render]] and [[renderSync]]
+ * APIs. Use [[compile]], [[compileString]], [[compileAsync]], and
+ * [[compileStringAsync]] instead.
+ */
+export interface LegacyException extends Error {
+  /**
+   * The error message. For Dart Sass, when possible this includes a highlighted
+   * indication of where in the source file the error occurred as well as the
+   * Sass stack trace.
+   */
+  message: string;
+
+  /**
+   * The error message. For Dart Sass, this is the same as the result of calling
+   * [[toString]], which is itself the same as [[message]] but with the prefix
+   * "Error:".
+   */
+  formatted: string;
+
+  /**
+   * The (1-based) line number on which the error occurred, if this exception is
+   * associated with a specific Sass file location.
+   */
+  line?: number;
+
+  /**
+   * The (1-based) column number within [[line]] at which the error occurred, if
+   * this exception is associated with a specific Sass file location.
+   */
+  column?: number;
+
+  /**
+   * Analogous to the exit code for an executable. `1` for an error caused by a
+   * Sass file, `3` for any other type of error.
+   */
+  status: number;
+
+  /**
+   * If this exception was caused by an error in a Sass file, this will
+   * represent the Sass file's location. It can be in one of three formats:
+   *
+   * * If the Sass file was loaded from disk, this is the path to that file.
+   * * If the Sass file was generated by an importer, this is its canonical URL.
+   * * If the Sass file was passed as [[LegacyStringOptions.data]] without a
+   *   corresponding [[LegacyStringOptions.file]], this is the special string
+   *   `"stdin"`.
+   */
+  file?: string;
+}