dart-sass/package
2022-06-30 16:05:41 -07:00
..
package.json Fix sass types for TS 4.7+ Node16/NodeNext module resolution (#1736) 2022-06-30 16:05:41 -07:00
README.npm.md Use the new JS API in the README (#1572) 2021-12-16 02:08:12 +00:00

A pure JavaScript implementation of Sass. Sass makes CSS fun again.

Sass logo npm statistics GitHub actions build status
Appveyor build status

This package is a distribution of Dart Sass, compiled to pure JavaScript with no native code or external dependencies. It provides a command-line sass executable and a Node.js API.

Usage

You can install Sass globally using npm install -g sass which will provide access to the sass executable. You can also add it to your project using npm install --save-dev sass. This provides the executable as well as a library:

const sass = require('sass');

const result = sass.compile(scssFilename);

// OR

// Note that `compileAsync()` is substantially slower than `compile()`.
const result = await sass.compileAsync(scssFilename);

See the Sass website for full API documentation.

Legacy API

See Also

  • Dart Sass, from which this package is compiled, can be used either as a stand-alone executable or as a Dart library. Running Dart Sass on the Dart VM is substantially faster than running the pure JavaScript version, so this may be appropriate for performance-sensitive applications. The Dart API is also (currently) more user-friendly than the JavaScript API. See the Dart Sass README for details on how to use it.

  • Node Sass, which is a wrapper around LibSass, the C++ implementation of Sass. Node Sass supports the same API as this package and is also faster (although it's usually a little slower than Dart Sass). However, it requires a native library which may be difficult to install, and it's generally slower to add features and fix bugs.

Behavioral Differences from Ruby Sass