Class SassMap
Hierarchy
- Value
- SassMap
Index
Constructors
Accessors
Methods
Constructors
constructor
-
Creates a new map.
Parameters
Optional contents: OrderedMap<Value, Value>
The contents of the map. This is an immutable [[OrderedMap]] from the
immutablepackage. Defaults to an empty map.
Returns SassMap
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.
contents
-
Returns the contents of this map as an immutable [[OrderedMap]] from the
immutablepackage.Returns OrderedMap<Value, Value>
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
separator
-
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
-
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
get
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
© 2006–2022 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/SassMap
Sass's map type.