SassFunction
Hierarchy
-
Value
- SassFunction
Index
Constructors
Accessors
Methods
Constructors
constructor
- new SassFunction(signature: string, callback: ((args: Value[]) => Value)): SassFunction
-
Creates a new first-class function that can be invoked using
meta.call().Parameters
-
signature: string
The function signature, like you'd write for the
@function rule. -
callback: ((args: Value[]) => Value)
The callback that's invoked when this function is called, just like for a CustomFunction.
Returns SassFunction
-
Accessors
asList
- get asList(): List<Value>
-
This value as a list.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns List<Value>
An immutable List from the
immutablepackage.
hasBrackets
- get hasBrackets(): boolean
-
Whether this value as a list has brackets.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns boolean
isTruthy
- get isTruthy(): boolean
-
Whether the value counts as
truein an@ifstatement and other contexts.Returns boolean
realNull
separator
- get separator(): ListSeparator
-
The separator for this value as a list.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns ListSeparator
Methods
assertBoolean
- assertBoolean(name?: string): SassBoolean
-
Throws if
thisisn't a SassBoolean.Functions should generally use isTruthy rather than requiring a literal boolean.
Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassBoolean
-
assertCalculation
- assertCalculation(name?: string): SassCalculation
-
Throws if
thisisn't a SassCalculation.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassCalculation
-
assertColor
assertFunction
- assertFunction(name?: string): SassFunction
-
Throws if
thisisn't a SassFunction.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassFunction
-
assertMap
assertMixin
assertNumber
- assertNumber(name?: string): SassNumber
-
Throws if
thisisn't a SassNumber.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassNumber
-
assertString
- assertString(name?: string): SassString
-
Throws if
thisisn't a SassString.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassString
-
equals
get
- get(index: number): undefined | Value
-
Returns the value at index
indexin this value as a list, orundefinedifindexisn't valid for this list.All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
This is a shorthand for
this.asList.get(index), although it may be more efficient in some cases.This method uses the same indexing conventions as the
immutablepackage: unlike Sass the index of the first element is 0, but like Sass negative numbers index from the end of the list.Parameters
-
index: number
Returns undefined | Value
-
hashCode
- hashCode(): number
-
Returns a hash code that can be used to store
thisin a hash map.Returns number
sassIndexToListIndex
- sassIndexToListIndex(sassIndex: Value, name?: string): number
-
Converts
sassIndexinto a JavaScript-style index into the list returned by asList.Sass indexes are one-based, while JavaScript indexes are zero-based. Sass indexes may also be negative in order to index from the end of the list.
Throws
ErrorIfsassIndexisn't a number, if that number isn't an integer, or if that integer isn't a valid index for asList.Parameters
-
sassIndex: Value
The Sass-style index into this as a list.
-
Optionalname: stringThe name of the function argument
sassIndexcame from (without the$) if it came from an argument. Used for error reporting.
Returns number
-
tryMap
© 2006–2025 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/SassFunction
Sass's function type.
Although first-class Sass functions can be processed by custom functions, there’s no way to invoke them outside of a Sass stylesheet.