SassCalculation
Hierarchy
- Value
- SassCalculation
Index
Constructors
Protected constructor
- new
Sass Calculation(): SassCalculation -
Returns SassCalculation
Accessors
arguments
- get arguments(): List<CalculationValue>
-
Returns a list of the calculation's
argumentsReturns List<CalculationValue>
as
- get asList(): List<Value>
-
This value as a list.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns List<Value>
An immutable List from the
immutablepackage.
has
- get hasBrackets(): boolean
-
Whether this value as a list has brackets.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns boolean
is
- get isTruthy(): boolean
-
Whether the value counts as
truein an@ifstatement and other contexts.Returns boolean
name
- get name(): string
-
Returns the calculation's
namefield.Returns string
real
separator
- get separator(): ListSeparator
-
The separator for this value as a list.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns ListSeparator
Methods
assert
- assert
Boolean(name?: string): SassBoolean -
Throws if
thisisn't a SassBoolean.⚠️ Heads up!
Functions should generally use isTruthy rather than requiring a literal boolean.
Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassBoolean
-
assert
- assert
Calculation(name?: string): SassCalculation -
Throws if
thisisn't a SassCalculation.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassCalculation
-
assert
assert
- assert
Function(name?: string): SassFunction -
Throws if
thisisn't a SassFunction.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassFunction
-
assert
assert
assert
- assert
Number(name?: string): SassNumber -
Throws if
thisisn't a SassNumber.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassNumber
-
assert
- assert
String(name?: string): SassString -
Throws if
thisisn't a SassString.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassString
-
equals
get
- get(index: number): undefined | Value
-
Returns the value at index
indexin this value as a list, orundefinedifindexisn't valid for this list.All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
This is a shorthand for
this.asList.get(index), although it may be more efficient in some cases.⚠️ Heads up!
This method uses the same indexing conventions as the
immutablepackage: unlike Sass the index of the first element is 0, but like Sass negative numbers index from the end of the list.Parameters
-
index: number
Returns undefined | Value
-
hash
sass
- sass
Index To List Index(sassIndex: Value, name?: string): number -
Converts
sassIndexinto a JavaScript-style index into the list returned by asList.Sass indexes are one-based, while JavaScript indexes are zero-based. Sass indexes may also be negative in order to index from the end of the list.
Throws
ErrorIfsassIndexisn't a number, if that number isn't an integer, or if that integer isn't a valid index for asList.Parameters
-
sassIndex: Value
The Sass-style index into this as a list.
-
Optionalname: stringThe name of the function argument
sassIndexcame from (without the$) if it came from an argument. Used for error reporting.
Returns number
-
try
Static calc
- calc(argument: CalculationValue): SassCalculation
-
Parameters
-
argument: CalculationValue
Returns SassCalculation
A calculation with the name
calcandargumentas its single argument. -
Static clamp
- clamp(min: CalculationValue, value?: CalculationValue, max?: CalculationValue): SassCalculation
-
Creates a value that represents
clamp(value, min, max).Throws
Errorif any ofvalue,min, ormaxare a quoted SassString.Throws
Errorifvalueis undefined andmaxis not undefined.Throws
Errorif eithervalueormaxis undefined and neitherminnorvalueis a SassString or CalculationInterpolation.Parameters
-
min: CalculationValue
-
Optionalvalue: CalculationValue -
Optionalmax: CalculationValue
Returns SassCalculation
A calculation with the name
clampandmin,value, andmaxas it's arguments, excluding any arguments that are undefined. -
Static max
- max(arguments: List<CalculationValue> | CalculationValue[]): SassCalculation
-
Creates a value that represents
max(arguments...).Throws
Errorifargumentscontains a quoted SassStringParameters
-
arguments: List<CalculationValue> | CalculationValue[]
Returns SassCalculation
A calculation with the name
maxandargumentsas its arguments. -
Static min
- min(arguments: List<CalculationValue> | CalculationValue[]): SassCalculation
-
Creates a value that represents
min(arguments...).Throws
Errorifargumentscontains a quoted SassStringParameters
-
arguments: List<CalculationValue> | CalculationValue[]
Returns SassCalculation
A calculation with the name
minandargumentsas its arguments. -
Sass's calculation type.
Note: in the JS API calculations are not simplified eagerly. This also means that unsimplified calculations are not equal to the numbers they would be simplified to.