SassNumber

Sassの数値型

階層

    • SassNumber

コンストラクタ

  • 単一の分子よりも複雑な単位を持つ新しい数値を作成します。

    構築時に、互換性のある分子単位と分母単位は、それらの間の変換係数に従って簡略化されます。

    パラメータ

    • value: number

      数値の数値。

    • オプション unit: string | {
          denominatorUnits?: string[] | List<string>;
          numeratorUnits?: string[] | List<string>;
      }

      これが文字列の場合、数値の単一の分子単位として使用されます。

    戻り値 SassNumber

アクセサ

  • get asInt(): null | number
  • valueisIntに従って整数である場合、その整数に丸められたvalueを返します。整数でない場合は、nullを返します。

    戻り値 null | number

  • get asList(): List<Value>
  • この値をリストとして取得します。

    すべての SassScript 値はリストとして使用できます。マップはペアのリストとしてカウントされ、他のすべての値は単一の値のリストとしてカウントされます。

    戻り値 List<Value>

    immutable パッケージのイミュータブルなリスト。

  • get hasBrackets(): boolean
  • この値がリストとしてブラケットを持っているかどうか。

    すべての SassScript 値はリストとして使用できます。マップはペアのリストとしてカウントされ、他のすべての値は単一の値のリストとしてカウントされます。

    戻り値 boolean

  • get hasUnits(): boolean
  • この数値が分子単位または分母単位を持っているかどうか。

    戻り値 boolean

  • get isTruthy(): boolean
  • @ifステートメントやその他のコンテキストで、値がtrueとしてカウントされるかどうか。

    戻り値 boolean

  • get separator(): ListSeparator
  • この値がリストとして使用される場合のセパレーター。

    すべての SassScript 値はリストとして使用できます。マップはペアのリストとしてカウントされ、他のすべての値は単一の値のリストとしてカウントされます。

    戻り値 ListSeparator

メソッド

  • thisSassBoolean でない場合にエラーをスローします。

    ⚠️ 注意!

    関数は一般的に、リテラルの boolean を要求するのではなく、isTruthy を使用する必要があります。

    パラメータ

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 SassBoolean

  • valueminmax の範囲内であれば、その値を返します。value が Sass の等価性に従って min または max と等しい場合、それぞれ min または max を返します。それ以外の場合は、エラーをスローします。

    パラメータ

    • min: number
    • max: number
    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 number

  • valueisInt に従って整数である場合、その整数に丸めた値を返します。それ以外の場合は、エラーをスローします。

    パラメータ

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 number

  • thisSassMap でない場合にエラーをスローします。

    パラメータ

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 SassMap

  • この数値に単位がない場合、それを返します。それ以外の場合は、エラーをスローします。

    パラメータ

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 SassNumber

  • この数値が unit を唯一の単位(かつ分子として)として持つ場合、この数値を返します。それ以外の場合は、エラーをスローします。

    パラメータ

    • unit: string
    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 SassNumber

  • この数値のコピーを返し、newNumeratorsnewDenominators で表される単位に変換します。

    convert とは異なり、この数値が単位を持たず、newNumerators または newDenominators が空でない場合、またはその逆の場合でもエラーをスローしません。代わりに、すべての単位なしの数値は、値を変更せずにすべての単位との間で変換可能であるものとして扱います。

    スロー

    この数値の単位が newNumeratorsnewDenominators と互換性がない場合は Error

    パラメータ

    • newNumerators: string[] | List<string>

      この数値を変換する分子単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • newDenominators: string[] | List<string>

      この数値を変換する分母単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 SassNumber

  • この数値のコピーを返し、newNumeratorsnewDenominators で表される単位に変換します。

    convertToMatch とは異なり、この数値が単位を持たず、newNumerators または newDenominators が空でない場合、またはその逆の場合でもエラーをスローしません。代わりに、すべての単位なしの数値は、値を変更せずにすべての単位との間で変換可能であるものとして扱います。

    スロー

    この数値の単位が other の単位と互換性がない場合は Error

    パラメータ

    • other: SassNumber
    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    • Optional otherName: string

      other が引数から来た場合($ なし)、その引数名の関数引数名。エラー報告に使用されます。

    戻り値 SassNumber

  • newNumeratorsnewDenominators で表される単位に変換された value を返します。

    convertValue とは異なり、この数値が単位を持たず、newNumerators または newDenominators が空でない場合、またはその逆の場合でもエラーをスローしません。代わりに、すべての単位なしの数値は、値を変更せずにすべての単位との間で変換可能であるものとして扱います。

    スロー

    この数値の単位が newNumeratorsnewDenominators と互換性がない場合は Error

    パラメータ

    • newNumerators: string[] | List<string>

      value を変換する分子単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • newDenominators: string[] | List<string>

      value を変換する分母単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 number

  • newNumeratorsnewDenominators で表される単位に変換された value を返します。

    convertValueToMatch とは異なり、この数値が単位を持たず、newNumerators または newDenominators が空でない場合、またはその逆の場合でもエラーをスローしません。代わりに、すべての単位なしの数値は、値を変更せずにすべての単位との間で変換可能であるものとして扱います。

    スロー

    この数値の単位が other の単位と互換性がない場合は Error

    パラメータ

    • other: SassNumber
    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    • Optional otherName: string

      other が引数から来た場合($ なし)、その引数名の関数引数名。エラー報告に使用されます。

    戻り値 number

  • これがちょうど1つの分子単位を持ち、その単位が unit と互換性があるかどうか。

    パラメータ

    • unit: string

    戻り値 boolean

  • この数値のコピーを返し、newNumeratorsnewDenominators で表される単位に変換します。

    スロー

    この数値の単位がnewNumeratorsおよびnewDenominatorsと互換性がない場合、またはこの数値が単位なしで、newNumeratorsまたはnewDenominatorsのいずれかが空でない場合、あるいはその逆の場合にErrorを発生させます。

    パラメータ

    • newNumerators: string[] | List<string>

      この数値を変換する分子単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • newDenominators: string[] | List<string>

      この数値を変換する分母単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 SassNumber

  • この数値のコピーを返し、otherと同じ単位に変換します。

    スロー

    この数値の単位がotherの単位と互換性がない場合、またはどちらかの数値が単位なしである一方、もう一方が単位を持っている場合にErrorを発生させます。

    パラメータ

    • other: SassNumber
    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    • Optional otherName: string

      other が引数から来た場合($ なし)、その引数名の関数引数名。エラー報告に使用されます。

    戻り値 SassNumber

  • newNumeratorsnewDenominators で表される単位に変換された value を返します。

    スロー

    この数値の単位がnewNumeratorsおよびnewDenominatorsと互換性がない場合、またはこの数値が単位なしで、newNumeratorsまたはnewDenominatorsのいずれかが空でない場合、あるいはその逆の場合にErrorを発生させます。

    パラメータ

    • newNumerators: string[] | List<string>

      value を変換する分子単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • newDenominators: string[] | List<string>

      value を変換する分母単位。これは、プレーンな JavaScript 配列、または immutable パッケージ の immutable List のいずれかです。

    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    戻り値 number

  • otherと同じ単位に変換されたvalueを返します。

    スロー

    この数値の単位がotherの単位と互換性がない場合、またはどちらかの数値が単位なしである一方、もう一方が単位を持っている場合にErrorを発生させます。

    パラメータ

    • other: SassNumber
    • オプション name: string

      this が引数から来た場合($ なし)、その関数の引数の名前。エラー報告に使用されます。

    • Optional otherName: string

      other が引数から来た場合($ なし)、その引数名の関数引数名。エラー報告に使用されます。

    戻り値 number

  • この値のリスト内にある、indexの位置の値を返します。あるいは、indexがこのリストに対して無効な場合はundefinedを返します。

    すべての SassScript 値はリストとして使用できます。マップはペアのリストとしてカウントされ、他のすべての値は単一の値のリストとしてカウントされます。

    これはthis.asList.get(index)の省略形ですが、場合によってはより効率的な可能性があります。

    ⚠️ 注意!

    このメソッドはimmutableパッケージと同じインデックス規則を使用します。Sassとは異なり、最初の要素のインデックスは0ですが、Sassと同様に、負の数はリストの末尾からインデックスを付けます。

    パラメータ

    • index: number

    戻り値: undefined | Value

  • この数値がunitのみを単位として(かつ分子として)持つかどうか。

    パラメータ

    • unit: string

    戻り値 boolean

  • sassIndexを、asListによって返されるリストへのJavaScript形式のインデックスに変換します。

    Sassのインデックスは1から始まるのに対し、JavaScriptのインデックスは0から始まります。Sassのインデックスは、リストの末尾からインデックスを付けるために負の数になることもあります。

    スロー

    sassIndexが数値でない場合、その数値が整数でない場合、またはその整数がasListの有効なインデックスでない場合にErrorを発生させます。

    パラメータ

    • sassIndex: Value

      リストとしてのこの値へのSass形式のインデックス。

    • オプション name: string

      sassIndexが引数から来た場合、($なしの)引数の関数名の引数名。エラー報告に使用されます。

    戻り値 number

  • this がマップとみなせる場合(空のリストは空のマップとみなします)はマップとして返し、そうでない場合は null を返します。

    null | SassMap を返します