SassArgumentList
階層
- SassList
- SassArgumentList
インデックス
コンストラクタ
コンストラクタ(省略、原文と同様)
- new
Sass ((省略、原文と同様)): SassArgumentList(省略、原文と同様)Argument List -
新しい引数リストを作成します。
パラメータ
-
contents: Value[] | List<Value>
リストの主要な内容を構成する位置引数。プレーンなJavaScript配列、または`immutable`パッケージのimmutable Listです。
-
keywords: Record<string, Value> | OrderedMap<string, Value>
この引数リストに添付されているキーワード引数。名前には`$`を含めないでください。引数名をフィールドとするプレーンなJavaScriptオブジェクト、または`immutable`パッケージのimmutable OrderedMapです。
-
オプション
separator: ListSeparatorこのリストの区切り文字。デフォルトは `','` です。
戻り値 SassArgumentList
-
アクセサ
asList
- get asList(): List<Value>
-
リストとしての値です。
すべてのSassScriptの値はリストとして使用できます。マップはペアのリストとしてカウントされ、他のすべての値は単一の値のリストとしてカウントされます。
戻り値: List<Value>
immutable
パッケージのイミュータブルなリストです。
hasBrackets
- get hasBrackets(): boolean
-
リストとしてのこの値に括弧があるかどうかです。
すべてのSassScriptの値はリストとして使用できます。マップはペアのリストとしてカウントされ、他のすべての値は単一の値のリストとしてカウントされます。
戻り値: boolean
isTruthy
- get isTruthy(): boolean
-
@if
文などのコンテキストで、値がtrue
としてカウントされるかどうかです。戻り値: boolean
keywords
- get keywords(): OrderedMap<string, Value>
-
この引数リストに添付されているキーワード引数です。
引数名には
$
は含まれません。戻り値: OrderedMap<string, Value>
immutable
パッケージのイミュータブルな OrderedMap です。
realNull
メソッド
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
- assertNumber(name?: string): SassNumber
-
this
が SassNumber でない場合、エラーをスローします。パラメータ
-
オプション
name: string引数から来た場合の、
this
の元の関数引数名($
なし)。エラー報告に使用されます。
SassNumber を返します
-
assertString
- assertString(name?: string): SassString
-
this
が SassString でない場合、エラーをスローします。パラメータ
-
オプション
name: string引数から来た場合の、
this
の元の関数引数名($
なし)。エラー報告に使用されます。
SassString を返します
-
equals
get
- get(index: number): undefined | Value
-
この値のインデックス
index
にある値をリストとして返します。index
がこのリストに対して無効な場合は、undefined
を返します。すべてのSassScriptの値はリストとして使用できます。マップはペアのリストとしてカウントされ、他のすべての値は単一の値のリストとしてカウントされます。
これは
this.asList.get(index)
の省略形ですが、場合によってはより効率的です。⚠️ 注意!
このメソッドは、
immutable
パッケージと同じインデックス規則を使用します。Sass とは異なり、最初の要素のインデックスは 0 ですが、Sass と同様に負の数はリストの末尾からインデックスされます。パラメータ
-
index: number
undefined | Value を返します
-
hashCode
sassIndexToListIndex
- sassIndexToListIndex(sassIndex: Value, name?: string): number
-
sassIndex
を、asList によって返されるリストへの JavaScript スタイルのインデックスに変換します。Sass のインデックスは 1 から始まりますが、JavaScript のインデックスは 0 から始まります。また、Sass のインデックスは、リストの末尾からインデックスするために負の値にすることもできます。
スローするエラー
Error
sassIndex
が数値でない場合、その数値が整数でない場合、またはその整数が asList に対する有効なインデックスでない場合。パラメータ
-
sassIndex: Value
リストとしてのこれへの Sass スタイルのインデックス。
-
オプション
name: string引数から来た場合の、関数引数
sassIndex
の名前(`$` なし)。エラー報告に使用されます。
number を返します
-
Sassの引数リスト型。
引数リストは、rest引数から生成されます。通常のSassListとは異なり、位置引数だけでなくキーワードマップも含む場合があります。