Sass
New Features • Custom CSS Functions, Null Safety, and Dark Mode Support Available Now!

Sass API Documentation

Access programmatic control over Sass compilation, functions, and variables with our powerful API.

Try the API in Your Project

import sass from 'sass';
const result = sass.compile('input.scss');
console.log(result.css);
                
Jump to API Reference

API Reference

Compilation Functions

sass.compileString(input: string, options: object)

Compiles a SCSS string to CSS with options for syntax and output format.

Parameters
  • input - SCSS string to compile
  • syntax - dart (default), indented, or scss
  • loadPaths - Paths to search for imports
  • outputStyle - expanded or compressed
Example
const result = sass.compileString('h1 { color: $color: #036 }', {
  loadPaths: ['src/styles/variables']
});
console.log(result.css.toString());
                        

Custom Functions

sass.addFunction(name: string, callback: Function)

Registers custom functions available in SCSS files.

Parameters
  • name - Function name in SCSS
  • callback - Function returning Sass value
Returns

Returns the function handle for later removal

Example
sass.addFunction('math.add($a, $b)', (a, b) => {
  return a.number + b.number;
});
                        

Need Help?

Explore our comprehensive documentation and community resources.