SassList

Sassのリスト型。

階層

コンストラクタ

constructor

アクセサ

asList hasBrackets isTruthy realNull

メソッド

assertBoolean assertCalculation assertColor assertFunction assertMap assertMixin assertNumber assertString equals get hashCode sassIndexToListIndex tryMap

コンストラクタ

constructor

  • 新しいリストを作成します。

    パラメータ

    • contents: Value[] | List<Value>

      リストの内容。これは、プレーンなJavaScript配列、またはimmutableパッケージからのimmutable Listのいずれかになります。

    • オプション options: {
          brackets?: boolean;
          separator?: ListSeparator;
      }
      • オプション brackets?: boolean

        リストが角かっこを持つかどうか。デフォルトはfalseです。

      • オプション separator?: ListSeparator

        このリストの要素間で使用する区切り文字。デフォルトは','です。

    戻り値 SassList

constructor

  • 空のリストを作成します。

    パラメータ

    • オプション options: {
          brackets?: boolean;
          separator?: ListSeparator;
      }
      • オプション brackets?: boolean

        リストが角かっこを持つかどうか。デフォルトはfalseです。

      • オプション separator?: ListSeparator

        このリストの要素間で使用する区切り文字。デフォルトは','です。

    戻り値 SassList

アクセサ

asList

  • get asList(): List<Value>

  • この値をリストとして取得します。

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

    戻り値 List<Value>

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

hasBrackets

  • get hasBrackets(): boolean

  • リストとしてのこの値が括弧を持っているかどうか。

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

    戻り値 boolean

isTruthy

  • get isTruthy(): boolean

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

    戻り値 boolean

realNull

  • get realNull(): null | Value

  • これが sassNull の場合は JavaScript の null 値を返し、それ以外の場合は this を返します。

    戻り値 null | Value

メソッド

assertBoolean

  • this が SassBoolean でない場合にスローします。

    ⚠️ 注意！

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

    パラメータ

    • オプション name: string

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

    戻り値 SassBoolean

assertCalculation

assertColor

  • this が SassColor でない場合にスローします。

    パラメータ

    • オプション name: string

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

    戻り値 SassColor

assertFunction

assertMap

  • this が SassMap でない場合にスローします。

    パラメータ

    • オプション name: string

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

    戻り値 SassMap

assertMixin

  • this が SassMixin でない場合にスローします。

    パラメータ

    • オプション name: string

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

    戻り値 SassMixin

assertNumber

assertString

  • this が SassString でない場合、例外をスローします。

    パラメータ

    • オプション name: string

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

    SassString を返します。

equals

get

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

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

    これは this.asList.get(index) のショートカットですが、場合によってはより効率的な可能性があります。

    ⚠️ 注意！

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

    パラメータ

    • index: number

    戻り値: undefined | Value

hashCode

  • this をハッシュマップに格納するために使用できるハッシュコードを返します。

    戻り値: number

sassIndexToListIndex

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

    Sass のインデックスは 1 ベースですが、JavaScript のインデックスは 0 ベースです。また、Sass のインデックスはリストの末尾からインデックス付けするために負の値を使用できます。

    例外をスロー

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

    パラメータ

    • sassIndex: Value

      リストとしてのこれへの Sass スタイルのインデックス。

    • オプション name: string

      sassIndex が引数から取得された場合、その引数の名前 ($ を除く)。エラーレポートに使用します。

    戻り値: number

tryMap

  • マップとしてカウントされる場合は this をマップとして返します (空のリストは空のマップとしてカウントされます)。そうでない場合は null を返します。

    戻り値: null | SassMap