sass/types/legacy/plugin_this.d.ts

A pure JavaScript implementation of Sass.

/**
 * The value of `this` in the context of a [[LegacyImporter]] or
 * [[LegacyFunction]] callback.
 *
 * @category Legacy
 * @deprecated This is only used by the legacy [[render]] and [[renderSync]]
 * APIs. Use [[compile]], [[compileString]], [[compileAsync]], and
 * [[compileStringAsync]] instead.
 */
export interface LegacyPluginThis {
  /**
   * A partial representation of the options passed to [[render]] or
   * [[renderSync]].
   */
  options: {
    /** The same [[LegacyPluginThis]] instance that contains this object. */
    context: LegacyPluginThis;

    /**
     * The value passed to [[LegacyFileOptions.file]] or
     * [[LegacyStringOptions.file]].
     */
    file?: string;

    /** The value passed to [[LegacyStringOptions.data]]. */
    data?: string;

    /**
     * The value passed to [[LegacySharedOptions.includePaths]] separated by
     * `";"` on Windows or `":"` on other operating systems. This always
     * includes the current working directory as the first entry.
     */
    includePaths: string;

    /** Always the number 10. */
    precision: 10;

    /** Always the number 1. */
    style: 1;

    /** 1 if [[LegacySharedOptions.indentType]] was `"tab"`, 0 otherwise. */
    indentType: 1 | 0;

    /**
     * The value passed to [[LegacySharedOptions.indentWidth]], or `2` otherwise.
     */
    indentWidth: number;

    /**
     * The value passed to [[LegacySharedOptions.linefeed]], or `"\n"`
     * otherwise.
     */
    linefeed: '\r' | '\r\n' | '\n' | '\n\r';

    /** A partially-constructed [[LegacyResult]] object. */
    result: {
      /** Partial information about the compilation in progress. */
      stats: {
        /**
         * The number of milliseconds between 1 January 1970 at 00:00:00 UTC and
         * the time at which Sass compilation began.
         */
        start: number;

        /**
         * [[LegacyFileOptions.file]] if it was passed, otherwise the string
         * `"data"`.
         */
        entry: string;
      };
    };
  };
}