Spec-Zone.ru › Sass

SassString

Тип строки Sass'а тип строки.

Иерархия

  • Значение
    • SassString
  • Определено в js-api-doc/value/string.d.ts:8
Индекс

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

конструктор

Доступные свойства

asList hasBrackets hasQuotes isTruthy realNull sassLength separator text

Методы

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

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

конструктор

  • new SassString(text: string, options?: {
    quotes?: boolean;
    }): SassString
  • Создает новую строку.

    Параметры

    • text: string

      Содержимое строки. Для строковых значений с кавычками это семантическое содержимое - любые последовательности escape, которые были написаны в исходном тексте, разрешаются до их значений Unicode. Для необрамленных строк, однако, последовательности escape сохраняются как буквенные обратные слэши.

    • Optional options: {
      quotes?: boolean;
      }
      • Optional quotes?: boolean

        Указывает, обрамлена ли строка кавычками. По умолчанию true.

    Возвращает SassString

    Переопределяет Значение.конструктор

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

конструктор

  • new SassString(options?: {
    quotes?: boolean;
    }): SassString
  • Создает пустую строку.

    Параметры

    • Optional options: {
      quotes?: boolean;
      }
      • Optional quotes?: boolean

        Указывает, обрамлена ли строка кавычками. По умолчанию true.

    Возвращает SassString

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

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

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

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

hasQuotes

  • get hasQuotes(): boolean
  • Содержит ли эта строка кавычки.

    Возвращает boolean

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

isTruthy

  • get isTruthy(): boolean
  • Определяет, считается ли значение true в операторе @if и других контекстах.

    Возвращает boolean

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

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

realNull

  • get realNull(): null | Значение
  • Возвращает JavaScript-значение null, если это sassNull, и возвращает this в противном случае.

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

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

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

sassLength

  • get sassLength(): number
  • Представление Sass длины этой строки.

    Sass обрабатывает строки как последовательность кодов Юникода, в то время как JavaScript обрабатывает их как последовательность кодовых единиц UTF-16. Например, символ U+1F60A УЛЫБАЮЩИЙСЯ ЛИЦО С УЛЫБАЮЩИМИСЯ ГЛАЗАМИ — это один код Юникода, но в UTF-16 он представлен двумя кодовыми единицами (0xD83D и 0xDE0A). Таким образом, в JavaScript, "n😊b".length возвращает 4, а в Sass string.length("n😊b") возвращает 3.

    Возвращает number

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

separator

  • get separator(): РазделительСписка
  • Разделитель для этого значения в виде списка.

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

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

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

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

text

  • get text(): string
  • Содержимое строки.

    Для строковых значений в кавычках это семантическое содержимое — любые управляющие последовательности, которые были записаны в исходном тексте, разрешаются до своих значений Юникода. Для необрамленных строк, однако, управляющие последовательности сохраняются как буквенные обратные косые черты.

    Это различие позволяет нам различать идентификаторы с управляющими последовательностями, например, url\u28 http://example.com\u29, и необрамленные строки, которые содержат символы, не являющиеся допустимыми в идентификаторах, например, url(http://example.com). К сожалению, это также означает, что мы не считаем foo и f\6F\6F одной и той же строкой.

    Возвращает string

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

Методы

assertBoolean

  • assertBoolean(name?: string): SassBoolean
  • Выбрасывает исключение, если this не является SassBoolean.

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

    Параметры

    • 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

sassIndexToStringIndex

  • sassIndexToStringIndex(sassIndex: Value, name?: string): number
  • Преобразует sassIndex в индекс JavaScript в text.

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

    Кроме того, индексы Sass ссылаются на кодовые точки Unicode, а индексы строк JavaScript — на кодовые единицы UTF-16. Например, символ U+1F60A УЛЫБАЮЩИЙСЯ ЛИЦО С УЛЫБАЮЩИМИСЯ ГЛАЗАМИ является одной кодовой точкой Unicode, но в UTF-16 представлен двумя кодовыми единицами (0xD83D и 0xDE0A). Поэтому в JavaScript, "n😊b".charCodeAt(1) возвращает 0xD83D, тогда как в Sass string.slice("n😊b", 1, 1) возвращает "😊".

    Эта функция преобразует индексы кодовых точек Sass в индексы кодовых единиц JavaScript. Это означает, что она имеет сложность O(n) по длине text.

    Исключение

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

    Параметры

    • sassIndex: Value
    • Optional name: string

    Возвращает number

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

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
    • 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/SassString

Spec-Zone.ru

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