Class SassString
Hierarchy
- Value
- SassString
Index
Constructors
constructor
Creates a new string.
Parameters
text: string
The contents of the string. For quoted strings, this is the semantic content—any escape sequences that were been written in the source text are resolved to their Unicode values. For unquoted strings, though, escape sequences are preserved as literal backslashes.
Optional options: { quotes?: boolean }
Optional quotes?: boolean
Whether the string is quoted. Defaults to
true.
Returns SassString
constructor
Creates an empty string.
Parameters
Optional options: { quotes?: boolean }
Optional quotes?: boolean
Whether the string is quoted. Defaults to
true.
Returns SassString
Accessors
as
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
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
has
Whether this string has quotes.
Returns boolean
is
Whether the value counts as
truein an@ifstatement and other contexts.Returns boolean
real
sass
Sass's notion of this string's length.
Sass treats strings as a series of Unicode code points while JavaScript treats them as a series of UTF-16 code units. For example, the character U+1F60A SMILING FACE WITH SMILING EYES is a single Unicode code point but is represented in UTF-16 as two code units (
0xD83Dand0xDE0A). So in JavaScript,"n😊b".lengthreturns4, whereas in Sassstring.length("n😊b")returns3.Returns number
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
text
The contents of the string.
For quoted strings, this is the semantic content—any escape sequences that were been written in the source text are resolved to their Unicode values. For unquoted strings, though, escape sequences are preserved as literal backslashes.
This difference allows us to distinguish between identifiers with escapes, such as
url\u28 http://example.com\u29, and unquoted strings that contain characters that aren't valid in identifiers, such asurl(http://example.com). Unfortunately, it also means that we don't considerfooandf\6F\6Fthe same string.Returns string
Methods
assert
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
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
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
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
hash
Returns a hash code that can be used to store
thisin a hash map.Returns number
sass
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
sass
Converts
sassIndexto a JavaScript index into text.Sass indices are one-based, while JavaScript indices are zero-based. Sass indices may also be negative in order to index from the end of the string.
In addition, Sass indices refer to Unicode code points while JavaScript string indices refer to UTF-16 code units. For example, the character U+1F60A SMILING FACE WITH SMILING EYES is a single Unicode code point but is represented in UTF-16 as two code units (
0xD83Dand0xDE0A). So in JavaScript,"n😊b".charCodeAt(1)returns0xD83D, whereas in Sassstring.slice("n😊b", 1, 1)returns"😊".This function converts Sass's code point indices to JavaScript's code unit indices. This means it's O(n) in the length of
text.Parameters
sassIndex: Value
Optional name: string
Returns number
try
Returns
thisas a map if it counts as one (empty lists count as empty maps) ornullif it doesn't.Returns null | SassMap
Sass's string type.