SassNumber

Sass 的數字類型。

階層

  • 值
    • SassNumber

建構函式

建構式

存取器

轉換為整數 (asInt) 轉換為列表 (asList) 分母單位 (denominatorUnits) 是否包含括號 (hasBrackets) 是否包含單位 (hasUnits) 是否為整數 (isInt) 是否為真值 (isTruthy) 分子單位 (numeratorUnits) 實際空值 (realNull) 分隔符號 (separator) 值 (value)

方法 (Methods)

assertBoolean assertCalculation assertColor assertFunction assertInRange assertInt assertMap assertMixin assertNoUnits assertNumber assertString assertUnit coerce coerceToMatch coerceValue coerceValueToMatch compatibleWithUnit convert convertToMatch convertValue convertValueToMatch equals get hasUnit hashCode sassIndexToListIndex tryMap

建構函式

建構式 (constructor)

  • 建立一個新的數字，其單位比單一分子供更複雜。

    建構時，任何相容的分子和分母單位都會根據它們之間的轉換因子進行簡化。

    參數

    • value: number

      數字的數值。

    • 選用 unit: string | {
          分母單位 (denominatorUnits)?: 字串 (string)[] | List<字串 (string)>;
          分子單位 (numeratorUnits)?: 字串 (string)[] | List<字串 (string)>;
      }

      如果這是字串，它將被用作數字的單一分子供單位。

    回傳 SassNumber

存取器

asInt🔗

asList🔗

denominatorUnits🔗

hasBrackets

  • get hasBrackets(): boolean

  • 此值作為列表是否具有括號。

    所有 SassScript 值都可以用作列表。映射計為成對列表，所有其他值計為單值列表。

    返回 boolean

hasUnits

isInt

isTruthy

  • get isTruthy(): boolean

  • 該值在 @if 陳述式和其他上下文中是否計為 true。

    返回 boolean

numeratorUnits

realNull

separator

value

方法 (Methods)

assertBoolean

assertCalculation

assertColor

assertFunction

assertInRange

  • 如果 value 介於 min 和 max 之間，則回傳 value。如果 value 根據 Sass 的相等性判斷等於 min 或 max，則分別回傳 min 或 max。否則，拋出錯誤。

    參數

    • min: number
    • max: number
    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 number

assertInt

  • 如果根據 isInt，value 是一個整數，則回傳將其四捨五入後的整數值。否則，拋出錯誤。

    參數

    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 number

assertMap

assertMixin

assertNoUnits

  • 如果此數字沒有單位，則回傳它。否則，拋出錯誤。

    參數

    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 SassNumber

assertNumber

assertString

assertUnit

  • 如果此數字的唯一單位（且作為分子）為 unit，則返回此數字。否則，拋出錯誤。

    參數

    • unit: string
    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 SassNumber

coerce

  • 返回此數字的副本，並轉換為以 newNumerators 和 newDenominators 表示的單位。

    與 convert 不同，如果此數字無單位且 newNumerators 或 newDenominators 不為空，反之亦然，此方法*不會*拋出錯誤。相反地，它會將所有無單位數字視為可與所有單位互相轉換，而不會更改其值。

    拋出

    如果此數字的單位與 newNumerators 和 newDenominators 不相容，則拋出 Error。

    參數

    • newNumerators: string[] | List<string>

      要將此數字轉換成分子的單位。這可以是普通的 JavaScript 陣列或來自 immutable 套件 的不可變 List。

    • newDenominators: string[] | List<string>

      要將此數字轉換成分母的單位。這可以是普通的 JavaScript 陣列或來自 immutable 套件 的不可變 List。

    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 SassNumber

強制類型匹配

  • 返回此數字的副本，並轉換為以 newNumerators 和 newDenominators 表示的單位。

    與 convertToMatch 不同，如果此數字無單位且 `newNumerators` 或 `newDenominators` 不為空，反之亦然，則此方法*不會*拋出錯誤。相反地，它會將所有無單位數字視為可與所有單位互相轉換，而不會改變其值。

    拋出

    如果此數字的單位與 `other` 的單位不相容，則會回傳 `Error`。

    參數

    • other: SassNumber
    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    • 選用 otherName: string

      如果函數參數 `other` 來自一個參數，則此為其名稱（不含 `$`）。用於錯誤報告。

    回傳 SassNumber

強制數值

  • 回傳 value，轉換為 `newNumerators` 和 `newDenominators` 所表示的單位。

    與 convertValue 不同，如果此數字無單位且 `newNumerators` 或 `newDenominators` 不為空，反之亦然，則此方法*不會*拋出錯誤。相反地，它會將所有無單位數字視為可與所有單位互相轉換，而不會改變其值。

    拋出

    如果此數字的單位與 newNumerators 和 newDenominators 不相容，則拋出 Error。

    參數

    • newNumerators: string[] | List<string>

      要將 value 轉換成分子的單位。這可以是普通的 JavaScript 陣列或來自 `immutable` 套件 的不可變 List。

    • newDenominators: string[] | List<string>

      用於轉換 值 的分母單位。這可以是一個普通的 JavaScript 陣列或來自 immutable 套件 的不可變 List。

    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 number

coerceValueToMatch

  • 回傳 value，轉換為 `newNumerators` 和 `newDenominators` 所表示的單位。

    與 convertValueToMatch 不同，如果此數字無單位且 newNumerators 或 newDenominators 不為空，反之亦然，則此方法*不會*拋出錯誤。相反地，它會將所有無單位數字視為可與所有單位互相轉換，而不會更改其值。

    拋出

    如果此數字的單位與 `other` 的單位不相容，則會回傳 `Error`。

    參數

    • other: SassNumber
    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    • 選用 otherName: string

      如果函數參數 `other` 來自一個參數，則此為其名稱（不含 `$`）。用於錯誤報告。

    回傳 number

compatibleWithUnit

  • 此數字是否恰好具有一個分子單位，且該單位與 unit 相容。

    參數

    • unit: string

    返回 boolean

convert

  • 返回此數字的副本，並轉換為以 newNumerators 和 newDenominators 表示的單位。

    拋出

    如果此數值的單位與 newNumerators 和 newDenominators 不相容，則會回傳 Error；或者如果此數值無單位，且 newNumerators 或 newDenominators 不為空，或反之亦然，也會回傳 Error。

    參數

    • newNumerators: string[] | List<string>

      要將此數字轉換成分子的單位。這可以是普通的 JavaScript 陣列或來自 immutable 套件 的不可變 List。

    • newDenominators: string[] | List<string>

      要將此數字轉換成分母的單位。這可以是普通的 JavaScript 陣列或來自 immutable 套件 的不可變 List。

    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 SassNumber

convertToMatch

  • 回傳此數值的副本，並轉換為與 other 相同的單位。

    拋出

    如果此數值的單位與 other 的單位不相容，或者其中一個數值無單位但另一個數值有單位，則會回傳 Error。

    參數

    • other: SassNumber
    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    • 選用 otherName: string

      如果函數參數 `other` 來自一個參數，則此為其名稱（不含 `$`）。用於錯誤報告。

    回傳 SassNumber

convertValue

  • 回傳 value，轉換為 `newNumerators` 和 `newDenominators` 所表示的單位。

    拋出

    如果此數值的單位與 newNumerators 和 newDenominators 不相容，則會回傳 Error；或者如果此數值無單位，且 newNumerators 或 newDenominators 不為空，或反之亦然，也會回傳 Error。

    參數

    • newNumerators: string[] | List<string>

      要將 value 轉換成分子的單位。這可以是普通的 JavaScript 陣列或來自 `immutable` 套件 的不可變 List。

    • newDenominators: string[] | List<string>

      用於轉換 值 的分母單位。這可以是一個普通的 JavaScript 陣列或來自 immutable 套件 的不可變 List。

    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    回傳 number

convertValueToMatch

  • 傳回 值，轉換為與 other 相同的單位。

    拋出

    如果此數值的單位與 other 的單位不相容，或者其中一個數值無單位但另一個數值有單位，則會回傳 Error。

    參數

    • other: SassNumber
    • 選用 name: string

      如果 this 來自一個參數，則此為函式參數的名稱（不包含 $）。用於錯誤報告。

    • 選用 otherName: string

      如果函數參數 `other` 來自一個參數，則此為其名稱（不含 `$`）。用於錯誤報告。

    回傳 number

equals

get

  • 將此值中索引為 index 的值作為列表返回，如果 index 對此列表無效，則返回 undefined。

    所有 SassScript 值都可以用作列表。映射計為成對列表，所有其他值計為單值列表。

    這是 this.asList.get(index) 的簡寫，但在某些情況下可能更有效率。

    ⚠️ 注意！

    此方法使用與 immutable 套件相同的索引慣例：與 Sass 不同，第一個元素的索引為 0，但與 Sass 相同，負數從列表的末尾開始索引。

    參數

    • index: number

    傳回 undefined | Value

hasUnit

  • 此數字是否將 unit 作為其唯一單位（並且作為分子）。

    參數

    • unit: string

    返回 boolean

hashCode

sassIndexToListIndex

  • 將 sassIndex 轉換為 JavaScript 風格的索引，以存取 asList 傳回的列表。

    Sass 索引是從 1 開始，而 JavaScript 索引是從 0 開始。Sass 索引也可以是負數，以便從列表的末尾開始索引。

    拋出

    如果 sassIndex 不是數字，或者該數字不是整數，或者該整數不是 asList 的有效索引，則會回傳 Error。

    參數

    • sassIndex: Value

      Sass 風格的索引，將此視為列表。

    • 選用 name: string

      name: string

    回傳 number

定義於 js-api-doc/value/index.d.ts:120

  • tryMap(): null | SassMap

    如果 this 可視為映射（空列表視為空映射），則將其作為映射傳回；否則傳回 null。