SassFunction
Hierarchie
- Value
- SassFunction
Index
Konstruktoren
Accessor
Methoden
Konstruktoren
constructor
- new
Sass (signatur: string, callback: ((args: Value[]) => Value)): SassFunctionFunction -
Erstellt eine neue erstklassige Funktion, die über
meta.call()aufgerufen werden kann.Parameter
-
signatur: string
Die Funktionssignatur, wie Sie sie für die Regel
@functionschreiben würden. -
callback: ((args: Value[]) => Value)
Der Callback, der aufgerufen wird, wenn diese Funktion aufgerufen wird, genau wie bei einer CustomFunction.
Gibt SassFunction zurück
-
Accessor
asList
- get asList(): List<Value>
-
Dieser Wert als Liste.
Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.
Gibt List<Value> zurück
Eine unveränderliche Liste aus dem
immutable-Paket.
hasBrackets
- get hasBrackets(): boolean
-
Ob dieser Wert als Liste Klammern hat.
Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.
Gibt boolean zurück
isTruthy
- get isTruthy(): boolean
-
Ob der Wert in einer
@if-Anweisung und anderen Kontexten alstruezählt.Gibt boolean zurück
realNull
separator
- get separator(): ListSeparator
-
Der Trenner für diesen Wert als Liste.
Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.
Gibt ListSeparator zurück
Methoden
assertBoolean
- assert
Boolean (name?: string): SassBoolean -
Wirft einen Fehler, wenn
thiskein SassBoolean ist.⚠️ Vorsicht!
Funktionen sollten generell isTruthy verwenden und keine booleschen Literale erzwingen.
Parameter
-
Optionalname: stringDer Name des Funktionsarguments, von dem
thisstammt (ohne das$), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.
Gibt SassBoolean zurück
-
assertCalculation
- assert
Calculation (name?: string): SassCalculation -
Wirft einen Fehler, wenn
thiskein SassCalculation ist.Parameter
-
Optionalname: stringDer Name des Funktionsarguments, von dem
thisstammt (ohne das$), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.
Gibt SassCalculation zurück
-
assertColor
assertFunction
- assert
Function (name?: string): SassFunction -
Wirft einen Fehler, wenn
thiskein SassFunction ist.Parameter
-
Optionalname: stringDer Name des Funktionsarguments, von dem
thisstammt (ohne das$), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.
Gibt SassFunction zurück
-
assertMap
assertMixin
assertNumber
- assert
Number (name?: string): SassNumber -
Wirft einen Fehler, wenn
thiskein SassNumber ist.Parameter
-
Optionalname: stringDer Name des Funktionsarguments, von dem
thisstammt (ohne das$), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.
Gibt SassNumber zurück
-
assertString
- assert
String (name?: string): SassString -
Wirft einen Fehler, wenn
thiskein SassString ist.Parameter
-
Optionalname: stringDer Name des Funktionsarguments, von dem
thisstammt (ohne das$), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.
Gibt SassString zurück
-
equals
get
- get(index: number): undefined | Value
-
Gibt den Wert am Index
indexin diesem Wert als Liste zurück, oderundefined, wennindexfür diese Liste ungültig ist.Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.
Dies ist eine Kurzform für
this.asList.get(index), obwohl es in manchen Fällen effizienter sein kann.⚠️ Vorsicht!
Diese Methode verwendet dieselben Indexierungs-Konventionen wie das
immutable-Paket: Im Gegensatz zu Sass ist der Index des ersten Elements 0, aber wie bei Sass werden negative Zahlen vom Ende der Liste indiziert.Parameter
-
index: number
Gibt undefined | Value zurück
-
hashCode
sassIndexToListIndex
- sass
Index (sassIndex: Value, name?: string): numberTo List Index -
Konvertiert
sassIndexin einen JavaScript-konformen Index für die Liste, die von asList zurückgegeben wird.Sass-Indizes sind einstellig, während JavaScript-Indizes nullbasiert sind. Sass-Indizes können auch negativ sein, um vom Ende der Liste zu indizieren.
Wirft
ErrorWennsassIndexkeine Zahl ist, wenn diese Zahl keine ganze Zahl ist oder wenn diese ganze Zahl kein gültiger Index für asList ist.Parameter
-
sassIndex: Value
Der Sass-Index für diesen Wert als Liste.
-
Optionalname: stringDer Name des Arguments
sassIndex(ohne das$), wenn es von einem Argument stammt. Wird für die Fehlerberichterstattung verwendet.
Gibt number zurück
-
Sass's Funktionstyp.
⚠️ Vorsicht!
Obwohl erstklassige Sass-Funktionen von benutzerdefinierten Funktionen verarbeitet werden können, gibt es keine Möglichkeit, sie außerhalb eines Sass-Style-Sheets aufzurufen.