Class 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.
Hierarchy
- Value
- SassFunction
Index
Constructors
Accessors
Methods
Constructors
constructor
- new
Sass Function(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
as
- 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.
has
- 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
is
- get isTruthy(): boolean
Whether the value counts as
truein an@ifstatement and other contexts.Returns boolean
real
- get realNull(): null | Value
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
assert
- assert
Boolean(name?: string): SassBoolean
Throws if
thisisn't a SassBoolean.⚠️ Heads up!
Functions should generally use isTruthy rather than requiring a literal boolean.
Parameters
Optional name: string
The name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassBoolean
assert
- assert
Color(name?: string): SassColor
assert
- assert
Function(name?: string): SassFunction
Throws if
thisisn't a SassFunction.Parameters
Optional name: string
The name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassFunction
assert
- assert
Map(name?: string): SassMap
assert
- assert
Number(name?: string): SassNumber
Throws if
thisisn't a SassNumber.Parameters
Optional name: string
The name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassNumber
assert
- assert
String(name?: string): SassString
Throws if
thisisn't a SassString.Parameters
Optional name: string
The name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassString
equals
- equals(other: Value ): boolean
Returns whether
thisrepresents the same value asother.Parameters
other: Value
Returns boolean
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.⚠️ Heads up!
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
hash
- hash
Code(): number
Returns a hash code that can be used to store
thisin a hash map.Returns number
sass
- sass
Index To List Index(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.
Parameters
sassIndex: Value
The Sass-style index into this as a list.
Optional name: string
The name of the function argument
sassIndexcame from (without the$) if it came from an argument. Used for error reporting.
Returns number
try
- try
Map(): null | SassMap
Returns
thisas a map if it counts as one (empty lists count as empty maps) ornullif it doesn't.Returns null | SassMap