Creates a new argument list.
The positional arguments that make up the primary contents of the list. This may be either a plain JavaScript array or an immutable List from the immutable
package.
The keyword arguments attached to this argument list, whose names should exclude $
. This can be either a plain JavaScript object with argument names as fields, or an immutable [[OrderedMap]] from the immutable
package
The separator for this list. Defaults to ','
.
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 keyword arguments attached to this argument list.
The argument names don't include $
.
An immutable [[OrderedMap]] from the immutable
package.
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/SassArgumentList
Sass's argument list type.
An argument list comes from a rest argument. It's distinct from a normal SassList in that it may contain a keyword map as well as the positional arguments.