Spec-Zone.ru › Sass

SassNumber

Числовой тип Sass.

Иерархия

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

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

конструктор

Свойства

asInt asList denominatorUnits hasBrackets hasUnits isInt isTruthy numeratorUnits realNull separator значение

Методы

assertBoolean assertCalculation assertColor assertFunction assertInRange assertInt assertMap assertMixin assertNoUnits assertNumber assertString assertUnit coerce coerceToMatch coerceValue coerceValueToMatch compatibleWithUnit convert convertToMatch convertValue convertValueToMatch equals get hasUnit hashCode sassIndexToListIndex tryMap

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

конструктор

  • new SassNumber(значение: number, единица?: string | {
    denominatorUnits?: string[] | List<string>;
    numeratorUnits?: string[] | List<string>;
    }): SassNumber

  • Создает новое число с более сложными единицами измерения, чем просто одна числительная.

    При создании любые совместимые числительные и знаменательные единицы измерения упрощаются в соответствии с коэффициентом перевода между ними.

    Параметры

    • значение: number

      Числовое значение числа.

    • Optional единица: string | {
      denominatorUnits?: string[] | List<string>;
      numeratorUnits?: string[] | List<string>;
      }

      Если это строка, она используется как единственная числительная единица измерения числа.

    Возвращает SassNumber

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

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

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

asInt

  • get asInt(): null | number

  • Если значение является целым числом по isInt, возвращает значение, округлённое до целого. Если это не целое число, возвращает null.

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

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

asList

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

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

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

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

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

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

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

denominatorUnits

  • get denominatorUnits(): List<string>

  • Единицы знаменателя этого числа в виде неизменяемого списка из immutable пакета.

    Возвращает List<string>

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

hasBrackets

  • get hasBrackets(): boolean

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

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

    Возвращает boolean

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

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

hasUnits

  • get hasUnits(): boolean

  • Содержит ли это число единицы числителя или знаменателя.

    Возвращает boolean

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

isInt

  • get isInt(): boolean

  • Является ли значение целым числом согласно логике равенства Sass.

    Возвращает boolean

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

isTruthy

  • get isTruthy(): boolean

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

    Возвращает boolean

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

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

numeratorUnits

  • get numeratorUnits(): List<string>

  • Единицы числителя этого числа в виде неизменяемого списка из immutable пакета.

    Возвращает List<string>

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

realNull

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

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

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

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

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

separator

  • get separator(): ListSeparator

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

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

    Возвращает ListSeparator

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

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

value

  • get value(): number

  • Числовое значение этого числа.

    Возвращает number

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

Методы

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

assertInRange

  • assertInRange(min: number, max: number, name?: string): number

  • Возвращает значение, если оно находится в диапазоне от min до max. Если значение равно min или max в соответствии с равенством Sass, возвращает min или max соответственно. В противном случае выбрасывает ошибку.

    Параметры

    • min: number
    • max: number
    • Optional name: string

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

    Возвращает number

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

assertInt

  • assertInt(name?: string): number

  • Если значение является целым числом согласно isInt, возвращает его, округлённое до целого числа. В противном случае выбрасывает ошибку.

    Параметры

    • Optional name: string

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

    Возвращает number

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

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

assertNoUnits

  • assertNoUnits(name?: string): SassNumber

  • Если у этого числа нет единиц измерения, возвращает его. В противном случае, выбрасывает ошибку.

    Параметры

    • Optional name: string

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

    Возвращает SassNumber

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

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

assertUnit

  • assertUnit(unit: string, name?: string): SassNumber

  • Если у этого числа unit в качестве единственной единицы измерения (и как числитель), возвращает это число. В противном случае, выбрасывает ошибку.

    Параметры

    • unit: string
    • Optional name: string

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

    Возвращает SassNumber

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

coerce

  • coerce(newNumerators: string[] | List<string>, newDenominators: string[] | List<string>, name?: string): SassNumber

  • Возвращает копию этого числа, преобразованного в единицы, представленные newNumerators и newDenominators.

    В отличие от convert, это не генерирует ошибку, если это число без единиц, и либо newNumerators, либо newDenominators не пустые, или наоборот. Вместо этого он обрабатывает все числа без единиц как преобразуемые в и из всех единиц без изменения значения.

    Исключения

    Error, если единицы этого числа несовместимы с newNumerators и newDenominators.

    Параметры

    • newNumerators: string[] | List<string>

      Единицы числителя для преобразования этого числа. Это может быть обычный JavaScript-массив или неизменяемый список из immutable пакета.

    • newDenominators: string[] | List<string>

      Единицы знаменателя для преобразования этого числа. Это может быть обычный JavaScript-массив или неизменяемый список из immutable пакета.

    • Optional name: string

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

    Возвращает SassNumber

    • Defined in js-api-doc/value/number.d.ts:223

coerceToMatch

  • coerceToMatch(other: SassNumber, name?: string, otherName?: string): SassNumber

  • Возвращает копию этого числа, преобразованного в единицы, представленные newNumerators и newDenominators.

    В отличие от convertToMatch, это не генерирует ошибку, если это число без единиц, и либо newNumerators, либо newDenominators не пустые, или наоборот. Вместо этого он обрабатывает все числа без единиц как преобразуемые в и из всех единиц без изменения значения.

    Исключения

    Error, если единицы этого числа несовместимы с единицами other.

    Параметры

    • other: SassNumber
    • Optional name: string

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

    • Optional otherName: string

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

    Возвращает SassNumber

    • Defined in js-api-doc/value/number.d.ts:247

coerceValue

  • coerceValue(newNumerators: string[] | List<string>, newDenominators: string[] | List<string>, name?: string): number

  • Возвращает значение, преобразованное в единицы, представленные newNumerators и newDenominators.

    В отличие от convertValue, это не генерирует ошибку, если это число без единиц, и либо newNumerators, либо newDenominators не пустые, или наоборот. Вместо этого все числа без единиц обрабатываются как преобразуемые в и из всех единиц без изменения значения.

    Исключения

    Error, если единицы этого числа несовместимы с newNumerators и newDenominators.

    Параметры

    • newNumerators: string[] | List<string>

      Единицы числителя для преобразования значения. Это может быть обычный JavaScript массив или неизменяемый список из пакета immutable.

    • newDenominators: string[] | List<string>

      Единицы знаменателя для преобразования значения. Это может быть обычный JavaScript массив или неизменяемый список из пакета immutable.

    • Optional name: string

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

    Возвращает number

    • Defined in js-api-doc/value/number.d.ts:276

coerceValueToMatch

  • coerceValueToMatch(other: SassNumber, name?: string, otherName?: string): number

  • Возвращает значение, преобразованное в единицы, представленные newNumerators и newDenominators.

    В отличие от convertValueToMatch, это не генерирует ошибку, если это число без единиц, и либо newNumerators, либо newDenominators не пустые, или наоборот. Вместо этого все числа без единиц обрабатываются как преобразуемые в и из всех единиц без изменения значения.

    Исключения

    Error, если единицы этого числа несовместимы с единицами other.

    Параметры

    • other: SassNumber
    • Optional name: string

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

    • Optional otherName: string

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

    Возвращает number

    • Defined in js-api-doc/value/number.d.ts:300

compatibleWithUnit

  • compatibleWithUnit(unit: string): boolean

  • Является ли эта единица точно одной единицей числителя, и совместима ли эта единица с unit.

    Параметры

    • unit: string

    Возвращает boolean

    • Defined in js-api-doc/value/number.d.ts:112

convert

  • convert(newNumerators: string[] | List<string>, newDenominators: string[] | List<string>, name?: string): SassNumber

  • Возвращает копию этого числа, преобразованного к единицам, представленным newNumerators и newDenominators.

    Исключения

    Error, если единицы этого числа несовместимы с newNumerators и newDenominators; или если это число без единиц, и либо newNumerators, либо newDenominators не пустые, или наоборот.

    Параметры

    • newNumerators: string[] | List<string>

      Единицы числителя, в которые необходимо преобразовать это число. Это может быть обычный JavaScript-массив или неизменяемый список из пакета immutable.

    • newDenominators: string[] | List<string>

      Единицы знаменателя, в которые необходимо преобразовать это число. Это может быть обычный JavaScript-массив или неизменяемый список из пакета immutable.

    • Optional name: string

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

    Возвращает SassNumber

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

convertToMatch

  • convertToMatch(other: SassNumber, name?: string, otherName?: string): SassNumber

  • Возвращает копию этого числа, преобразованного в те же единицы, что и other.

    Исключения

    Error, если единицы этого числа несовместимы с единицами other, или если оба числа без единиц, но другое - нет.

    Параметры

    • other: SassNumber
    • Optional name: string

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

    • Optional otherName: string

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

    Возвращает SassNumber

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

convertValue

  • convertValue(newNumerators: string[] | List<string>, newDenominators: string[] | List<string>, name?: string): number

  • Возвращает значение, преобразованное к единицам, представленным newNumerators и newDenominators.

    Исключения

    Error, если единицы этого числа несовместимы с newNumerators и newDenominators; или если это число без единиц, и либо newNumerators, либо newDenominators не пустые, или наоборот.

    Параметры

    • newNumerators: string[] | List<string>

      Единицы числителя, в которые необходимо преобразовать значение. Это может быть обычный JavaScript-массив или неизменяемый список из пакета immutable.

    • newDenominators: string[] | List<string>

      Единицы знаменателя, в которые необходимо преобразовать значение. Это может быть обычный JavaScript-массив или неизменяемый список из пакета immutable.

    • Optional name: string

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

    Возвращает number

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

convertValueToMatch

  • convertValueToMatch(other: SassNumber, name?: string, otherName?: string): number

  • Возвращает значение, преобразованное в те же единицы измерения, что и other.

    Исключения

    Error, если единицы измерения этого числа несовместимы с единицами измерения other, или если оба числа без единиц измерения, но другое имеет единицы измерения.

    Параметры

    • other: SassNumber
    • Optional name: string

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

    • Optional otherName: string

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

    Возвращает number

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

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

hasUnit

  • hasUnit(unit: string): boolean

  • Является ли этой числовой единицей unit единственной единицей измерения (и в качестве числителя)?

    Параметры

    • unit: string

    Возвращает boolean

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

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
    • 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
  • Сообщения
    • Версия
    • Устаревание
    • DeprecationOrId
    • DeprecationStatus
    • deprecations

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

Spec-Zone.ru

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