SassNumber

Sass 的 数字类型。

层次结构

  • 值
    • SassNumber

构造函数

constructor

访问器

asInt asList denominatorUnits hasBrackets hasUnits isInt isTruthy numeratorUnits realNull separator value

方法

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

      数字的数值。

    • Optional 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

方法

assertBoolean

assertCalculation

assertColor

assertFunction

assertInRange

  • 如果 value 在 min 和 max 之间，则返回 value。如果 value 等于 min 或 max（根据 Sass 的相等性），则分别返回 min 或 max。否则，抛出错误。

    参数

    • min: number
    • max: number
    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 number

assertInt

  • 如果 value 是一个整数（根据 isInt），则返回该整数。否则，抛出错误。

    参数

    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 number

assertMap

assertMixin

assertNoUnits

  • 如果该数字没有单位，则返回它。否则，抛出错误。

    参数

    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 SassNumber

assertNumber

assertString

assertUnit

  • 如果该数字的唯一单位（以及分子）是 unit，则返回该数字。否则，抛出错误。

    参数

    • unit: string
    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 SassNumber

coerce

  • 返回此数字的副本，转换为 newNumerators 和 newDenominators 表示的单位。

    与 convert 不同，如果此数字无单位，并且 newNumerators 或 newDenominators 不为空，反之亦然，则不会抛出错误。相反，它将所有无单位的数字视为可转换为所有单位，反之亦然，而不会更改 值。

    抛出

    Error 如果此数字的单位与 newNumerators 和 newDenominators 不兼容。

    参数

    • newNumerators: string[] | List<string>

      要将此数字转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • newDenominators: string[] | List<string>

      要将此数字转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 SassNumber

coerceToMatch

  • 返回此数字的副本，转换为 newNumerators 和 newDenominators 表示的单位。

    与 convertToMatch 不同，如果此数字无单位，并且 newNumerators 或 newDenominators 不为空，反之亦然，则不会抛出错误。相反，它将所有无单位的数字视为可转换为所有单位，反之亦然，而不会更改 值。

    抛出

    Error 如果此数字的单位与 other 的单位不兼容。

    参数

    • other: SassNumber
    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    • Optional otherName: string

      如果 other 来自参数，则该参数的函数参数 other 的名称（不带 $）。用于错误 报告。

    返回 SassNumber

coerceValue

  • 返回 value，转换为 newNumerators 和 newDenominators 表示的单位。

    与 convertValue 不同，如果此数字无单位，并且 newNumerators 或 newDenominators 不为空，反之亦然，则不会抛出错误。相反，它将所有无单位的数字视为可转换为所有单位，反之亦然，而不会更改 值。

    抛出

    Error 如果此数字的单位与 newNumerators 和 newDenominators 不兼容。

    参数

    • newNumerators: string[] | List<string>

      要将 value 转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • newDenominators: string[] | List<string>

      要将 value 转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 number

coerceValueToMatch

  • 返回 value，转换为 newNumerators 和 newDenominators 表示的单位。

    与 convertValueToMatch 不同，如果此数字无单位，并且 newNumerators 或 newDenominators 不为空，反之亦然，则不会抛出错误。相反，它将所有无单位的数字视为可转换为所有单位，反之亦然，而不会更改 值。

    抛出

    Error 如果此数字的单位与 other 的单位不兼容。

    参数

    • other: SassNumber
    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    • Optional otherName: string

      如果 other 来自参数，则该参数的函数参数 other 的名称（不带 $）。用于错误 报告。

    返回 number

compatibleWithUnit

  • 此数字是否只有一个分子单位，且该单位与 unit 兼容。

    参数

    • unit: string

    返回 boolean

convert

  • 返回此数字的副本，转换为 newNumerators 和 newDenominators 表示的单位。

    抛出

    Error 如果此数字的单位与 newNumerators 和 newDenominators 不兼容；或者如果此数字无单位，并且 newNumerators 或 newDenominators 不为空，反之亦然。 

    参数

    • newNumerators: string[] | List<string>

      要将此数字转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • newDenominators: string[] | List<string>

      要将此数字转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 SassNumber

convertToMatch

  • 返回此数字的副本，转换为与 other 相同的单位。

    抛出

    Error 如果此数字的单位与 other 的单位不兼容，或者如果两个数字都无单位，但另一个数字 不为空。

    参数

    • other: SassNumber
    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    • Optional otherName: string

      如果 other 来自参数，则该参数的函数参数 other 的名称（不带 $）。用于错误 报告。

    返回 SassNumber

convertValue

  • 返回 value，转换为 newNumerators 和 newDenominators 表示的单位。

    抛出

    Error 如果此数字的单位与 newNumerators 和 newDenominators 不兼容；或者如果此数字无单位，并且 newNumerators 或 newDenominators 不为空，反之亦然。 

    参数

    • newNumerators: string[] | List<string>

      要将 value 转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • newDenominators: string[] | List<string>

      要将 value 转换为的分母单位。这可以是纯 JavaScript 数组或来自 immutable 包 的不可变列表。

    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    返回 number

convertValueToMatch

  • 返回 value，转换为与 other 相同的单位。

    抛出

    Error 如果此数字的单位与 other 的单位不兼容，或者如果两个数字都无单位，但另一个数字 不为空。

    参数

    • other: SassNumber
    • Optional name: string

      如果来自参数，则 this 所来自的函数参数名称（不带 $）。用于错误报告。

    • Optional otherName: string

      如果 other 来自参数，则该参数的函数参数 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 转换为 asList 返回的列表中的 JavaScript 风格索引。

    Sass 索引是基于一的，而 JavaScript 索引是基于零的。Sass 索引也可能是负数，以便从列表的末尾索引。

    抛出

    Error 如果 sassIndex 不是数字，如果该数字不是整数，或者如果该整数不是 asList 的有效索引。

    参数

    • sassIndex: Value

      作为列表的 this 中的 Sass 风格索引。

    • Optional name: string

      如果函数参数 sassIndex 来自一个参数（不带 $），则为该参数的名称。用于错误报告。

    返回 number

tryMap