SassArgumentList
階層
- SassList
- SassArgumentList
索引
建構函式
存取器
方法
建構函式
建構式 (constructor)
- new
Sass (contents: Value[] | List<Value>, keywords: Record<string, Value> | OrderedMap<string, Value>, separator?: ListSeparator): SassArgumentListArgument List -
建立一個新的參數列表。
參數
-
contents: Value[] | List<Value>
組成列表主要內容的位置參數。這可以是一個普通的 JavaScript 陣列，或者是一個來自 `immutable` 套件 的不可變列表。
-
keywords: Record<string, Value> | OrderedMap<string, Value>
附加到此參數列表的關鍵字參數，其名稱應排除 `$`。這可以是一個普通的 JavaScript 物件，以參數名稱作為欄位，或者是一個來自 `immutable` 套件 的不可變 OrderedMap。
-
選用separator: ListSeparator此列表的分隔符號。預設為 `','`。
回傳 SassArgumentList
-
存取器
asList
- get asList(): List<Value>
-
此值作為列表。
所有 SassScript 值皆可作為列表使用。映射 (Map) 可視為鍵值對列表，而所有其他值則可視為單值列表。
返回 List<Value>
一個來自
immutable套件 的不可變列表 (Immutable List)。
hasBrackets
- get hasBrackets(): boolean
-
此值作為列表時是否帶有括號。
所有 SassScript 值皆可作為列表使用。映射 (Map) 可視為鍵值對列表，而所有其他值則可視為單值列表。
返回 boolean
isTruthy
- get isTruthy(): boolean
-
此值在
@if陳述式和其他情況下是否視為true。返回 boolean
keywords
- get keywords(): OrderedMap<string, Value>
-
附加到此參數列表的關鍵字參數。
參數名稱不包含
$。返回 OrderedMap<string, Value>
一個來自
immutable套件 的不可變有序映射 (Immutable OrderedMap)。
realNull
方法
assertBoolean
- assert
Boolean (name?: string): SassBoolean -
如果
this不是 SassBoolean，則拋出錯誤。⚠️ 注意！
函式通常應該使用 isTruthy，而不是要求一個字面上的布林值。
參數
-
選用name: string如果
this來自一個參數，則此為函式參數的名稱（不含$）。用於錯誤回報。
回傳 SassBoolean
-
assertCalculation
- assert
Calculation (name?: string): SassCalculation -
如果
this不是 SassCalculation，則拋出錯誤。參數
-
選用name: string如果
this來自一個參數，則此為函式參數的名稱（不含$）。用於錯誤回報。
回傳 SassCalculation
-
assertColor
assertFunction
- assert
Function (name?: string): SassFunction -
如果 `this` 不是 SassFunction，則拋出錯誤。
參數
-
選用name: string如果
this來自一個參數，則此為函式參數的名稱（不含$）。用於錯誤回報。
回傳 SassFunction
-
assertMap
assertMixin
assertNumber
- assert
Number (name?: string): SassNumber -
如果 `this` 不是 SassNumber 則拋出錯誤。
參數
-
選用name: string如果
this來自一個參數，則此為函式參數的名稱（不含$）。用於錯誤回報。
回傳 SassNumber
-
assertString
- assert
String (name?: string): SassString -
如果 `this` 不是 SassString 則拋出錯誤。
參數
-
選用name: string如果
this來自一個參數，則此為函式參數的名稱（不含$）。用於錯誤回報。
回傳 SassString
-
equals
get
- get(index: number): undefined | Value
-
以列表形式返回此值中索引為
index的值，如果index對此列表無效，則返回undefined。所有 SassScript 值皆可作為列表使用。映射 (Map) 可視為鍵值對列表，而所有其他值則可視為單值列表。
這是
this.asList.get(index)的簡寫，但在某些情況下可能會更有效率。⚠️ 注意！
此方法使用與
immutable套件相同的索引慣例：與 Sass 不同，第一個元素的索引為 0，但與 Sass 相似，負數從列表的末尾開始索引。參數
-
index: number（數字）
返回 undefined | Value（值）
-
hashCode（雜湊碼）
sassIndexToListIndex（Sass 索引轉換為列表索引）
- sassIndexToListIndex(sassIndex: Value（值）, name?: string（字串）): number（數字）
-
將
sassIndex轉換為 JavaScript 風格的索引，指向 asList 返回的列表。Sass 索引從一開始，而 JavaScript 索引從零開始。 Sass 索引也可以是負數，以便從列表的末尾開始索引。
拋出
Error（錯誤） 如果sassIndex不是數字，或者該數字不是整數，或者該整數不是 asList 的有效索引。參數
-
sassIndex: Value（值）
Sass 風格的索引，指向此列表。
-
選用name: string如果函數參數
sassIndex來自於一個參數，則此為該參數的名稱（不包含$）。用於錯誤報告。
返回 number（數字）
-
Sass 的參數列表類型。
參數列表來自其餘參數。它與一般的 SassList 不同，因為它可能包含關鍵字映射以及位置參數。