SassMap
Hierarchy
- Value
- SassMap
Index
Constructors
constructor
- new
Sass Map(contents?: OrderedMap<Value, Value>): SassMap -
Creates a new map.
Parameters
-
Optionalcontents: OrderedMap<Value, Value>The contents of the map. This is an immutable
OrderedMapfrom theimmutablepackage. Defaults to an empty map.
Returns SassMap
-
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.
contents
- get contents(): OrderedMap<Value, Value>
-
Returns the contents of this map as an immutable OrderedMap from the
immutablepackage.Returns OrderedMap<Value, Value>
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
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
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassBoolean
-
assert
- assert
Calculation(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
-
assert
assert
- assert
Function(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
-
assert
assert
assert
- assert
Number(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
-
assert
- assert
String(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
hash
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.
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
-
Sass's map type.