Creates a new first-class function that can be invoked using meta.call()
.
The function signature, like you'd write for the @function rule
.
The callback that's invoked when this function is called, just like for a CustomFunction.
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.
An immutable List from the immutable
package.
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.
Whether the value counts as true
in an @if
statement and other contexts.
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.
Throws if this
isn't a SassBoolean.
Functions should generally use isTruthy rather than requiring a literal boolean.
The name of the function argument this
came from (without the $
) if it came from an argument. Used for error reporting.
Throws if this
isn't a SassFunction.
The name of the function argument this
came from (without the $
) if it came from an argument. Used for error reporting.
Throws if this
isn't a SassNumber.
The name of the function argument this
came from (without the $
) if it came from an argument. Used for error reporting.
Throws if this
isn't a SassString.
The name of the function argument this
came from (without the $
) if it came from an argument. Used for error reporting.
Returns whether this
represents the same value as other
.
Returns the value at index index
in this value as a list, or undefined
if index
isn'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 immutable
package: unlike Sass the index of the first element is 0, but like Sass negative numbers index from the end of the list.
Returns a hash code that can be used to store this
in a hash map.
Converts sassIndex
into 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.
The Sass-style index into this as a list.
The name of the function argument sassIndex
came from (without the $
) if it came from an argument. Used for error reporting.
Returns this
as a map if it counts as one (empty lists count as empty maps) or null
if it doesn't.
© 2006–2022 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/SassFunction
Sass's function type.
⚠️ Heads up!
Although first-class Sass functions can be processed by custom functions, there's no way to invoke them outside of a Sass stylesheet.