Class SassList
Hierarchy
- Value
- SassList
Index
Constructors
Accessors
Methods
Constructors
constructor
-
Creates a new list.
Parameters
contents: Value[] | List<Value>
The contents of the list. This may be either a plain JavaScript array or an immutable List from the
immutablepackage.Optional options: { brackets?: boolean; separator?: ListSeparator }
Optional brackets?: boolean
Whether the list has square brackets. Defaults to
false.Optional separator?: ListSeparator
The separator to use between elements of this list. Defaults to
','.
Returns SassList
constructor
-
Creates an empty list.
Parameters
Optional options: { brackets?: boolean; separator?: ListSeparator }
Optional brackets?: boolean
Whether the list has square brackets. Defaults to
false.Optional separator?: ListSeparator
The separator to use between elements of this list. Defaults to
','.
Returns SassList
Accessors
asList
-
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
-
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
-
Whether the value counts as
truein an@ifstatement and other contexts.Returns boolean
realNull
Methods
assertBoolean
-
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
assertColor
assertFunction
-
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
assertMap
assertNumber
-
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
assertString
-
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
-
Returns whether
thisrepresents the same value asother.Parameters
other: Value
Returns boolean
get
-
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
hashCode
-
Returns a hash code that can be used to store
thisin a hash map.Returns number
sassIndexToListIndex
-
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
tryMap
-
Returns
thisas a map if it counts as one (empty lists count as empty maps) ornullif it doesn't.Returns null | SassMap
© 2006–2022 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/SassList
Sass's list type.