Spec-Zone.ru › Sass

SassFunction

Тип функции Sass, тип функции.

Хотя пользовательские функции могут обрабатывать функции Sass первого класса, нет способа вызвать их вне файла стилей Sass.

Иерархия

  • Value
    • SassFunction
  • Определено в js-api-doc/value/function.d.ts:11
Индекс

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

конструктор

Свойства

asList hasBrackets isTruthy realNull separator

Методы

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

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

конструктор

  • new SassFunction(signature: string, callback: ((args: Value[]) => Value)): SassFunction

  • Создает новую функцию первого класса, которую можно вызвать с помощью meta.call().

    Параметры

    • signature: string

      Подпись функции, как вы бы написали для @function rule.

    • callback: ((args: Value[]) => Value)

      Обратный вызов, который вызывается при вызове этой функции, точно так же, как для CustomFunction.

        • (args: Value[]): Value

        • Параметры

          • args: Value[]

          Возвращает Value

    Возвращает SassFunction

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

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

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

asList

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

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

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

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

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

    Унаследовано от 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

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

    Возвращает boolean

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

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

realNull

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

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

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

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

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

separator

  • get separator(): РазделительСписок

  • Разделитель для этого значения в виде списка.

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

    Возвращает РазделительСписок

    Унаследовано от Value.separator

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

Методы

assertBoolean

  • assertBoolean(name?: string): SassBoolean

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

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

    Параметры

    • Optional name: string

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

    Возвращает SassBoolean

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

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

assertCalculation

  • assertCalculation(name?: string): SassCalculation

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

    Параметры

    • Optional name: string

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

    Возвращает SassCalculation

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

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

assertColor

  • assertColor(name?: string): SassColor

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

    Параметры

    • Optional name: string

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

    Возвращает SassColor

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

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

assertFunction

  • assertFunction(name?: string): SassFunction

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

    Параметры

    • Optional name: string

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

    Возвращает SassFunction

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

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

assertMap

  • assertMap(name?: string): SassMap

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

    Параметры

    • Optional name: string

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

    Возвращает SassMap

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

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

assertMixin

  • assertMixin(name?: string): SassMixin

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

    Параметры

    • Optional name: string

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

    Возвращает SassMixin

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

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

assertNumber

  • assertNumber(name?: string): SassNumber

  • Бросает исключение, если this не является объектом SassNumber.

    Параметры

    • Optional name: string

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

    Возвращает SassNumber

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

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

assertString

  • assertString(name?: string): SassString

  • Бросает исключение, если this не является объектом SassString.

    Параметры

    • Optional 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 в этом значении как списка, или undefined, если index недействителен для этого списка.

    Все значения 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 в индекс в стиле JavaScript для списка, возвращаемого asList.

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

    Бросает исключение

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

    Параметры

    • sassIndex: Value

      Индекс в стиле Sass для этого элемента как списка.

    • Optional 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
sass
  • Compile
    • AsyncCompiler
    • Compiler
    • CompileResult
    • compile
    • compileAsync
    • compileString
    • compileStringAsync
    • initAsyncCompiler
    • initCompiler
  • Options
    • Options
    • StringOptions
    • OutputStyle
    • StringOptionsWithImporter
    • StringOptionsWithoutImporter
    • Синтаксис
  • Logger
    • Logger
      • silent
    • Logger
    • Расположение источника
    • Область источника
    • LoggerWarnOptions
  • Importer
    • NodePackageImporter
    • FileImporter
    • Importer
    • ImporterResult
  • Пользовательская функция
    • CalculationInterpolation
    • CalculationOperation
    • SassArgumentList
    • SassBoolean
    • SassCalculation
    • SassColor
    • SassFunction
    • SassList
    • SassMap
    • SassMixin
    • SassNumber
    • SassString
    • Value
    • CalculationOperator
    • CalculationValue
    • CustomFunction
    • Разделитель списка
    • sassFalse
    • sassNull
    • sassTrue
  • Другое
    • Исключение
    • CanonicalizeContext
    • Deprecations
    • LegacyFileOptions
    • Имя канала
    • Имя канала HSL
    • Имя канала HWB
    • Имя канала Lab
    • Имя канала Lch
    • Имя канала RGB
    • Имя канала XYZ
    • Цветовое пространство HSL
    • Цветовое пространство HWB
    • Цветовое пространство Lab
    • Цветовое пространство Lch
    • Цветовое пространство RGB
    • Цветовое пространство XYZ
    • Метод отображения гаммы
    • Метод интерполяции оттенка
    • Известное цветовое пространство
    • Полярное цветовое пространство
    • PromiseOr
    • Прямоугольное цветовое пространство
    • info
  • Legacy
    • types
      • Boolean
      • Цвет
      • Ошибка
      • Список
      • Карта
      • Null
      • Число
      • Строка
    • LegacyException
    • LegacyImporterThis
    • LegacyPluginThis
    • LegacyResult
    • LegacySharedOptions
    • LegacyStringOptions
    • LegacyAsyncFunction
    • LegacyAsyncFunctionDone
    • LegacyAsyncImporter
    • LegacyFunction
    • LegacyImporter
    • LegacyImporterResult
    • LegacyOptions
    • LegacySyncFunction
    • LegacySyncImporter
    • LegacyValue
    • FALSE
    • NULL
    • TRUE
    • render
    • renderSync
  • Messages
    • Версия
    • 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/SassFunction

Spec-Zone.ru

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