SassList

Sass 的列表类型。

层次结构

值
- SassList
  - SassArgumentList

索引

构造函数

constructor

new SassList(contents: Value[] | List<Value>, options?: {
brackets?: boolean;
separator?: ListSeparator;
}): SassList
创建一个新的列表。
参数
- contents: Value[] | List<Value>
  
  列表的内容。这可以是普通的 JavaScript 数组或来自 immutable 包的不可变 List。
- 可选 options: {
  brackets?: boolean;
  separator?: ListSeparator;
  }
  - 可选 brackets?: boolean
    
    列表是否带有方括号。默认为 false。
  - 可选 separator?: ListSeparator
    
    在此列表的元素之间使用的分隔符。默认为 ','。
返回 SassList
重写 Value.constructor
- 定义于 js-api-doc/value/list.d.ts:33

constructor

new SassList(options?: {
brackets?: boolean;
separator?: ListSeparator;
}): SassList
创建一个空列表。
参数
- 可选 options: {
  brackets?: boolean;
  separator?: ListSeparator;
  }
  - 可选 brackets?: boolean
    
    列表是否带有方括号。默认为 false。
  - 可选 separator?: ListSeparator
    
    在此列表的元素之间使用的分隔符。默认为 ','。
返回 SassList
重写 Value.constructor
- 定义于 js-api-doc/value/list.d.ts:50

访问器

asList

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

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

返回 List<Value>
来自 immutable 包的不可变 List。
继承自 Value.asList
- 定义于 js-api-doc/value/index.d.ts:77

hasBrackets

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

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

返回 boolean
继承自 Value.hasBrackets
- 定义于 js-api-doc/value/index.d.ts:85

isTruthy

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

返回 boolean
继承自 Value.isTruthy
- 定义于 js-api-doc/value/index.d.ts:91

realNull

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

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

方法

assertBoolean

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

⚠️ 注意！

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

assertCalculation

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

assertColor

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

assertFunction

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

assertMap

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

assertMixin

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

assertNumber

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

assertString

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

equals

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

get

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

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

这是 this.asList.get(index) 的简写，但在某些情况下可能效率更高。

⚠️ 注意！

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

hashCode

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

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

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
继承自 Value.sassIndexToListIndex
- 定义于 js-api-doc/value/index.d.ts:120

tryMap

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

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

层次结构

索引

构造函数

访问器

方法

构造函数

constructor

参数

contents: Value[] | List<Value>

可选 options: { brackets?: boolean; separator?: ListSeparator; }

可选 brackets?: boolean

可选 separator?: ListSeparator

返回 SassList

constructor

参数

可选 options: { brackets?: boolean; separator?: ListSeparator; }

可选 brackets?: boolean

可选 separator?: ListSeparator

返回 SassList

访问器

asList

返回 List<Value>

hasBrackets

返回 boolean

isTruthy

返回 boolean

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

`可选` options: {
brackets?: boolean;
separator?: ListSeparator;
}

`可选` brackets?: boolean

`可选` separator?: ListSeparator

`可选` options: {
brackets?: boolean;
separator?: ListSeparator;
}

`可选` brackets?: boolean

`可选` separator?: ListSeparator

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string

`可选` name: string