Spec-Zone.ru › Sass

CustomFunction<sync>

CustomFunction<sync extends "sync" | "async">: ((args: Значение[]) => PromiseOr<Значение, sync>)

Параметры типа

  • sync extends "sync" | "async"

    Синхронная CustomFunction<'sync'> должна возвращать результат синхронно, но при этом её можно передать в compile и compileString помимо compileAsync и compileStringAsync.

    Асинхронная CustomFunction<'async'> может возвращать результат синхронно или асинхронно, но её можно использовать только с compileAsync и compileStringAsync.

Объявление типа

    • (args: Значение[]): PromiseOr<Значение, sync>
    • Обратный вызов, реализующий пользовательскую функцию Sass. Может быть передан в functions.

      constresult = sass.compile('style.scss', {
      functions: {
      "sum($arg1, $arg2)": (args) => {
      constarg1 = args[0].assertNumber('arg1');
      constvalue1 = arg1.value;
      constvalue2 = args[1].assertNumber('arg2')
      .convertValueToMatch(arg1, 'arg2', 'arg1');
      returnnewsass.SassNumber(value1 + value2).coerceToMatch(arg1);
      }
      }
      });

      Исключения

      any - Данная функция может выбросить ошибку, которую компилятор Sass будет обрабатывать как ошибку выполнения функции. Если у объекта исключения есть свойство message, оно будет использовано в качестве сообщения об ошибке; в противном случае будет использовано свойство toString() объекта исключения. Это означает, что пользовательские функции могут безопасно выбрасывать простые строки.

      Параметры

      • args: Значение[]

        Массив аргументов, переданных вызывающей функцией. Если функция принимает произвольное количество аргументов, последний элемент будет SassArgumentList.

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

      Результат работы функции. Он может быть в форме Promise, но если это так, то функция может быть передана только в compileAsync и compileStringAsync, а не в compile или compileString.

  • Defined in js-api-doc/options.d.ts:77
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
    • Пользовательская функция
    • 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
    • Статус устаревания
    • deprecations

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

Spec-Zone.ru

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