Spec-Zone.ru › Sass

SassArgumentList

Тип списка аргументов Sass'а, см. описание.

Список аргументов получен из rest аргумента. Он отличается от обычного SassList тем, что может содержать карту ключевых слов, а также позиционные аргументы.

Иерархия

  • SassList
    • SassArgumentList
  • Определено в js-api-doc/value/argument_list.d.ts:16
Индекс

Конструкторы

конструктор

Свойства

asList hasBrackets isTruthy keywords realNull

Методы

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

Конструкторы

конструктор

  • new SassArgumentList(contents: Value[] | List<Value>, keywords: Record<string, Value> | OrderedMap<string, Value>, separator?: ListSeparator): SassArgumentList

  • Создаёт новый список аргументов.

    Параметры

    • contents: Value[] | List<Value>

      Позиционные аргументы, составляющие основное содержание списка. Это может быть обычный JavaScript массив или неизменяемый список из пакета immutable.

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

      Ключевые аргументы, прикреплённые к этому списку аргументов, имена которых должны $. Это может быть обычный JavaScript объект с именами аргументов в качестве полей или неизменяемый OrderedMap из пакета immutable

    • Optional separator: ListSeparator

      Разделитель для этого списка. По умолчанию ','.

    Возвращает SassArgumentList

    Переопределяет SassList.конструктор

    • Определено в js-api-doc/value/argument_list.d.ts:32

Доступ к данным

asList

  • get asList(): List<Значение>

  • Это значение в виде списка.

    Все значения SassScript могут использоваться как списки. Карты считаются списками пар, а все другие значения считаются списками с одним значением.

    Возвращает List<Значение>

    Неизменяемый список из immutable пакета.

    Унаследовано от SassList.asList

    • Определено в js-api-doc/value/index.d.ts:77

hasBrackets

  • get hasBrackets(): boolean

  • Указывает, содержит ли это значение в виде списка скобки.

    Все значения SassScript могут использоваться как списки. Карты считаются списками пар, а все другие значения считаются списками с одним значением.

    Возвращает boolean

    Унаследовано от SassList.hasBrackets

    • Определено в js-api-doc/value/index.d.ts:85

isTruthy

  • get isTruthy(): boolean

  • Указывает, считается ли значение true в операторе @if и в других контекстах.

    Возвращает boolean

    Унаследовано от SassList.isTruthy

    • Определено в js-api-doc/value/index.d.ts:91

keywords

  • get keywords(): OrderedMap<string, Значение>

  • Ключевые аргументы, присоединённые к этому списку аргументов.

    Имена аргументов не включают $.

    Возвращает OrderedMap<string, Значение>

    Неизменяемая OrderedMap из immutable пакета.

    • Определено в js-api-doc/value/argument_list.d.ts:46

realNull

  • get realNull(): null | Значение

  • Возвращает значение JavaScript's null, если это sassNull, и возвращает this в противном случае.

    Возвращает null | Значение

    Унаследовано от SassList.realNull

    • Определено в js-api-doc/value/index.d.ts:97

Методы

assertBoolean

  • assertBoolean(name?: string): SassBoolean

  • Бросает исключение, если this не является SassBoolean.

    Функции обычно должны использовать isTruthy вместо требования буквального булевого значения.

    Параметры

    • Optional name: string

      Имя аргумента функции this (без $), если он пришёл из аргумента. Используется для отладки ошибок.

    Возвращает SassBoolean

    Унаследовано от SassList.assertBoolean

    • Определено в js-api-doc/value/index.d.ts:147

assertCalculation

  • assertCalculation(name?: string): SassCalculation

  • Бросает исключение, если this не является SassCalculation.

    Параметры

    • Optional name: string

      Имя аргумента функции this (без $), если он пришёл из аргумента. Используется для отладки ошибок.

    Возвращает SassCalculation

    Унаследовано от SassList.assertCalculation

    • Определено в js-api-doc/value/index.d.ts:155

assertColor

  • assertColor(name?: string): SassColor

  • Бросает исключение, если this не является SassColor.

    Параметры

    • Optional name: string

      Имя аргумента функции this (без $), если он пришёл из аргумента. Используется для отладки ошибок.

    Возвращает SassColor

    Унаследовано от SassList.assertColor

    • Определено в js-api-doc/value/index.d.ts:163

assertFunction

  • assertFunction(name?: string): SassFunction

  • Бросает исключение, если this не является SassFunction.

    Параметры

    • Optional name: string

      Имя аргумента функции this (без $), если он пришёл из аргумента. Используется для отладки ошибок.

    Возвращает SassFunction

    Унаследовано от SassList.assertFunction

    • Определено в js-api-doc/value/index.d.ts:171

assertMap

  • assertMap(name?: string): SassMap

  • Бросает исключение, если this не является SassMap.

    Параметры

    • Optional name: string

      Имя аргумента функции this (без $), если он пришёл из аргумента. Используется для отладки ошибок.

    Возвращает SassMap

    Унаследовано от SassList.assertMap

    • Определено в js-api-doc/value/index.d.ts:179

assertMixin

  • assertMixin(name?: string): SassMixin

  • Бросает исключение, если this не является SassMixin.

    Параметры

    • Optional name: string

      Имя аргумента функции this (без $), если он пришёл из аргумента. Используется для отладки ошибок.

    Возвращает SassMixin

    Унаследовано от SassList.assertMixin

    • Определено в js-api-doc/value/index.d.ts:187

assertNumber

  • assertNumber(name?: string): SassNumber

  • Выбрасывает исключение, если this не является SassNumber.

    Параметры

    • Optional name: string

      Имя аргумента функции this, из которого он был получен (без $), если он был получен из аргумента. Используется для отладки ошибок.

    Возвращает SassNumber

    Унаследовано от SassList.assertNumber

    • Определено в js-api-doc/value/index.d.ts:195

assertString

  • assertString(name?: string): SassString

  • Выбрасывает исключение, если this не является SassString.

    Параметры

    • Optional name: string

      Имя аргумента функции this, из которого он был получен (без $), если он был получен из аргумента. Используется для отладки ошибок.

    Возвращает SassString

    Унаследовано от SassList.assertString

    • Определено в js-api-doc/value/index.d.ts:203

equals

  • equals(other: Value): boolean

  • Возвращает значение, являющееся ли this тем же значением, что и other.

    Параметры

    • other: Value

    Возвращает boolean

    Унаследовано от SassList.equals

    • Определено в js-api-doc/value/index.d.ts:212

get

  • get(index: number): undefined | Value

  • Возвращает значение в индексе index в этом значении как список, или undefined, если index недействительно для этого списка.

    Все значения SassScript могут использоваться как списки. Карты считаются списками пар, а все другие значения считаются списками с одним значением.

    Это сокращение для this.asList.get(index), хотя в некоторых случаях оно может быть более эффективным.

    Этот метод использует те же соглашения об индексировании, что и пакет immutable: в отличие от Sass, индекс первого элемента равен 0, но, как и в Sass, отрицательные числа индексируют с конца списка.

    Параметры

    • index: number

    Возвращает undefined | Value

    Унаследовано от SassList.get

    • Определено в js-api-doc/value/index.d.ts:136

hashCode

  • hashCode(): number

  • Возвращает хэш-код, который можно использовать для хранения this в хэш-таблице.

    Возвращает number

    Унаследовано от SassList.hashCode

    • Определено в js-api-doc/value/index.d.ts:215

sassIndexToListIndex

  • sassIndexToListIndex(sassIndex: Value, name?: string): number

  • Преобразует sassIndex в индекс в стиле JavaScript для списка, возвращаемого asList.

    Индексы Sass основаны на единице, а индексы JavaScript основаны на нуле. Индексы Sass также могут быть отрицательными для индексирования с конца списка.

    Выбрасывает

    Error Если sassIndex не является числом, если это число не целое или если это целое число не является допустимым индексом для asList.

    Параметры

    • sassIndex: Value

      Индекс в стиле Sass в этот список.

    • Optional name: string

      Имя аргумента функции sassIndex, из которого он был получен (без $), если он был получен из аргумента. Используется для отладки ошибок.

    Возвращает number

    Унаследовано от SassList.sassIndexToListIndex

    • Определено в js-api-doc/value/index.d.ts:120

tryMap

  • tryMap(): null | SassMap

  • Возвращает this как карту, если она считается таковой (пустые списки считаются пустыми картами) или null, если нет.

    Возвращает null | SassMap

    Унаследовано от SassList.tryMap

    • Определено в js-api-doc/value/index.d.ts:209
sass
  • Compile
    • AsyncCompiler
    • Compiler
    • CompileResult
    • compile
    • compileAsync
    • compileString
    • compileStringAsync
    • initAsyncCompiler
    • initCompiler
  • Options
    • Options
    • StringOptions
    • OutputStyle
    • StringOptionsWithImporter
    • StringOptionsWithoutImporter
    • Syntax
  • Logger
    • Logger
      • silent
    • Logger
    • SourceLocation
    • SourceSpan
    • LoggerWarnOptions
  • Importer
    • NodePackageImporter
    • FileImporter
    • Importer
    • ImporterResult
  • Функция пользовательского определения
    • CalculationInterpolation
    • CalculationOperation
    • SassArgumentList
    • SassBoolean
    • SassCalculation
    • SassColor
    • SassFunction
    • SassList
    • SassMap
    • SassMixin
    • SassNumber
    • SassString
    • Value
    • CalculationOperator
    • CalculationValue
    • CustomFunction
    • ListSeparator
    • sassFalse
    • sassNull
    • sassTrue
  • Другое
    • Exception
    • CanonicalizeContext
    • Deprecations
    • LegacyFileOptions
    • ChannelName
    • ChannelNameHsl
    • ChannelNameHwb
    • ChannelNameLab
    • ChannelNameLch
    • ChannelNameRgb
    • ChannelNameXyz
    • ColorSpaceHsl
    • ColorSpaceHwb
    • ColorSpaceLab
    • ColorSpaceLch
    • ColorSpaceRgb
    • ColorSpaceXyz
    • GamutMapMethod
    • HueInterpolationMethod
    • KnownColorSpace
    • PolarColorSpace
    • PromiseOr
    • RectangularColorSpace
    • info
  • Legacy
    • types
      • Boolean
      • Color
      • Error
      • List
      • Map
      • Null
      • Number
      • String
    • LegacyException
    • LegacyImporterThis
    • LegacyPluginThis
    • LegacyResult
    • LegacySharedOptions
    • LegacyStringOptions
    • LegacyAsyncFunction
    • LegacyAsyncFunctionDone
    • LegacyAsyncImporter
    • LegacyFunction
    • LegacyImporter
    • LegacyImporterResult
    • LegacyOptions
    • LegacySyncFunction
    • LegacySyncImporter
    • LegacyValue
    • FALSE
    • NULL
    • TRUE
    • render
    • renderSync
  • Сообщения
    • Version
    • Deprecation
    • DeprecationOrId
    • DeprecationStatus
    • deprecations

© 2006–2025 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/SassArgumentList

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API