SassArgumentList

Sass 的参数列表类型。

参数列表来自剩余参数。它不同于常规 SassList，因为它可能包含关键字映射以及位置参数。

层次结构

SassList
- SassArgumentList

索引

构造函数

访问器

asList hasBrackets isTruthy keywords realNull

方法

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

构造函数

constructor

new SassArgumentList(contents: Value[] | List<Value>, keywords: Record<string, Value> | OrderedMap<string, Value>, separator?: ListSeparator): SassArgumentList
创建一个新的参数列表。
参数
- contents: Value[] | List<Value>
  
  构成列表主要内容的位置参数。这可以是纯 JavaScript 数组，也可以是 immutable 包中的不变 List。
- keywords: Record<string, Value> | OrderedMap<string, Value>
  
  附加到此参数列表的关键字参数，其名称应不包括 $。这可以是带有参数名称作为字段的普通 JavaScript 对象，也可以是 immutable 包中的不变 OrderedMap
- 可选 separator: ListSeparator
  
  此列表的分隔符。默认为 ','。
返回 SassArgumentList
覆盖 SassList.constructor
- 在 js-api-doc/value/argument_list.d.ts:32 中定义

访问器

asList

get asList(): List<Value>
此值作为列表。

所有 SassScript 值均可用作列表。映射计为对列表，所有其他值计为单值列表。

返回 List<Value>
来自 immutable 包的不可变列表。
继承自 SassList.asList
- 在 js-api-doc/value/index.d.ts:57 中定义

hasBrackets

get hasBrackets(): boolean
此值作为列表是否具有括号。

所有 SassScript 值均可用作列表。映射计为对列表，所有其他值计为单值列表。

返回 boolean
继承自 SassList.hasBrackets
- 在 js-api-doc/value/index.d.ts:65 中定义

isTruthy

get isTruthy(): boolean
该值在 @if 语句和其他上下文中是否计为 true。

返回 boolean
继承自 SassList.isTruthy
- 在 js-api-doc/value/index.d.ts:71 中定义

keywords

get keywords(): OrderedMap<string, Value>
此参数列表附加的关键字参数。

参数名称不包含 $。

返回 OrderedMap<string, Value>
来自 immutable 包的不可变 OrderedMap。
- 定义于 js-api-doc/value/argument_list.d.ts:46

realNull

get realNull(): null | Value
如果这是 sassNull，则返回 JavaScript 的 null 值，否则返回 this。

返回 null | Value
继承自 SassList.realNull
- 定义于 js-api-doc/value/index.d.ts:77

方法

assertBoolean

assertBoolean(name?: string): SassBoolean
如果 this 不是 SassBoolean，则抛出异常。

⚠️ 注意！

函数通常应该使用 isTruthy 而不是要求一个字面布尔值。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回 SassBoolean
继承自 SassList.assertBoolean
- 定义在 js-api-doc/value/index.d.ts:127

assertCalculation

assertCalculation(name?: string): SassCalculation
如果 this 不是 SassCalculation，则抛出异常。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回 SassCalculation
继承自 SassList.assertCalculation
- 定义在 js-api-doc/value/index.d.ts:135

assertColor

assertColor(name?: string): SassColor
如果 this 不是 SassColor，则抛出异常。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回 SassColor
继承自 SassList.assertColor
- 定义于 js-api-doc/value/index.d.ts:143

assertFunction

assertFunction(name?: string): SassFunction
如果 this 不是 SassFunction，则抛出异常。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回 SassFunction
继承自 SassList.assertFunction
- 定义于 js-api-doc/value/index.d.ts:151

assertMap

assertMap(name?: string): SassMap
如果 this 不是 SassMap，则抛出异常。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回 SassMap
继承自 SassList.assertMap
- 定义在 js-api-doc/value/index.d.ts:159

assertMixin

assertMixin(name?: string): SassMixin
如果 this 不是 SassMixin，则抛出异常。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回 SassMixin
继承自 SassList.assertMixin
- 定义在 js-api-doc/value/index.d.ts:167

assertNumber

assertNumber(name?: string): SassNumber
如果 this 不是 SassNumber，则抛出异常。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回 SassNumber
继承自 SassList.assertNumber
- 定义在 js-api-doc/value/index.d.ts:175

assertString

assertString(name?: string): SassString
如果this不是SassString，则抛出异常。
参数
- 可选 name: string
  
  如果函数参数 this 来自参数，则为函数参数名称（不带 $）。用于错误报告。
返回SassString
继承自SassList.assertString
- 定义于js-api-doc/value/index.d.ts:183

equals

equals(other: Value): boolean
返回this是否表示与other相同的值。
参数
- other: Value
返回 boolean
继承自SassList.equals
- 定义于js-api-doc/value/index.d.ts:192

get

get(index: number): undefined | Value
返回此值中索引为 index 的值（作为列表），如果 index 对此列表无效，则返回 undefined。

所有 SassScript 值均可用作列表。映射计为对列表，所有其他值计为单值列表。

这是 this.asList.get(index) 的简写，尽管在某些情况下它可能更有效。

⚠️ 注意！

此方法使用与 immutable 包相同的索引约定：与 Sass 不同，第一个元素的索引为 0，但与 Sass 相同，负数从列表的末尾开始索引。
参数
- index: number
返回 undefined | Value
继承自 SassList.get
- 定义于 js-api-doc/value/index.d.ts:116

hashCode

hashCode(): number
返回一个哈希码，可用于将 this 存储在哈希映射中。

返回 number
继承自 SassList.hashCode
- 定义于 js-api-doc/value/index.d.ts:195

sassIndexToListIndex

sassIndexToListIndex(sassIndex: Value, name?: string): number
将 sassIndex 转换为 asList 返回的列表中的 JavaScript 风格的索引。

Sass 索引从 1 开始，而 JavaScript 索引从 0 开始。Sass 索引还可以为负数，以便从列表的末尾开始索引。

抛出
Error 如果 sassIndex 不是数字，如果该数字不是整数，或者如果该整数不是 asList 的有效索引。
参数
- sassIndex: Value
  
  此项作为列表的 Sass 风格索引。
- 可选 name: string
  
  如果 sassIndex 来自参数，则为函数参数 sassIndex 的名称（不带 $）。用于错误报告。
返回 number
继承自 SassList.sassIndexToListIndex
- 定义于 js-api-doc/value/index.d.ts:100

tryMap

tryMap(): null | SassMap
如果它算作一个（空列表算作空映射），则将 this 作为映射返回，否则返回 null 。

返回 null | SassMap
继承自 SassList.tryMap
- 定义于 js-api-doc/value/index.d.ts:189

层次结构

索引

构造函数

访问器

方法

构造函数

constructor

参数

contents: Value[] | List<Value>

keywords: Record<string, Value> | OrderedMap<string, Value>

可选 separator: ListSeparator

返回 SassArgumentList

访问器

asList

返回 List<Value>

hasBrackets

返回 boolean

isTruthy

返回 boolean

keywords

返回 OrderedMap<string, Value>

realNull

返回 null | Value

方法

assertBoolean

⚠️ 注意！

参数

可选 name: string

返回 SassBoolean

assertCalculation

参数

可选 name: string

返回 SassCalculation

assertColor

参数

可选 name: string

返回 SassColor

assertFunction

参数

可选 name: string

返回 SassFunction

assertMap

参数

可选 name: string

返回 SassMap

assertMixin

参数

可选 name: string

返回 SassMixin

assertNumber

参数

可选 name: string

返回 SassNumber

assertString

参数

可选 name: string

返回SassString

equals

参数

other: Value

返回 boolean

get

⚠️ 注意！

参数

index: number

返回 undefined | Value

hashCode

返回 number

sassIndexToListIndex

抛出

参数

sassIndex: Value

可选 name: string

返回 number

tryMap

返回 null | SassMap

`可选` separator: ListSeparator

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string