SassFunction
階層
- 值
- SassFunction
索引
建構函式
存取器
方法
建構函式
建構函式 (constructor)
- new
Sass (signature: string, callback: ((args: Value[]) => Value)): SassFunctionFunction -
建立一個新的第一級函式，可以使用
meta.call()呼叫。參數
-
signature: string
函式簽名，就像您為
@function 規則編寫的簽名一樣。 -
callback: ((args: Value[]) => Value)
呼叫此函式時所呼叫的回呼函式，就像 CustomFunction 一樣。
回傳 SassFunction
-
存取器
asList
- get asList(): List<Value>
-
此值作為 list。
所有 SassScript 值都可以用作 list。Map 可視為成對的 list，所有其他值則可視為單值的 list。
回傳 List<Value>
來自
immutable套件 的不可變 List。
hasBrackets
- get hasBrackets(): boolean
-
此值作為 list 是否有括號。
所有 SassScript 值都可以用作 list。Map 可視為成對的 list，所有其他值則可視為單值的 list。
回傳 boolean（布林值）
isTruthy
- get isTruthy(): boolean
-
此值在
@if陳述式和其他情況下是否視為true。回傳 boolean（布林值）
realNull
separator
- get separator(): ListSeparator
-
此值作為列表的分隔符號。
所有 SassScript 值都可以用作 list。Map 可視為成對的 list，所有其他值則可視為單值的 list。
回傳 ListSeparator
方法
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 值都可以用作 list。Map 可視為成對的 list，所有其他值則可視為單值的 list。
這是 `this.asList.get(index)` 的簡寫，但在某些情況下可能更有效率。
⚠️ 注意！
此方法使用與 `immutable` 套件相同的索引慣例：與 Sass 不同，第一個元素的索引為 0，但與 Sass 相同，負數從列表的末尾開始索引。
參數
-
index: number
回傳 undefined | Value
-
hashCode
sassIndexToListIndex
- sass
Index (sassIndex: Value, name?: string): numberTo List Index -
將
sassIndex轉換為 JavaScript 風格的索引，用於 asList 返回的列表。Sass 索引是從一開始的，而 JavaScript 索引是從零開始的。Sass 索引也可以是負數，以便從列表的末尾開始索引。
拋出
Error如果sassIndex不是數字，如果該數字不是整數，或者如果該整數不是 asList 的有效索引。參數
-
sassIndex: Value
Sass 風格的索引，將其作為列表。
-
選用name: string如果函數參數
sassIndex來自一個參數，則為該參數的名稱（不含$）。用於錯誤報告。
回傳 number
-
Sass 的函式類型。
⚠️ 注意！
雖然一級 Sass 函式可以由自訂函式處理，但無法在 Sass 樣式表之外呼叫它們。