SassNumber

Sass's Zahlentyp.

Hierarchie

Konstruktoren

constructor

Accessor

alsGanzzahl alsListe nennerEinheiten hatKlammern hatEinheiten istGanzzahl istWahrheitswert zählerEinheiten echtesNull trenner wert

Methoden

alsBoolescherWertÜberprüfen alsBerechnungÜberprüfen alsFarbeÜberprüfen alsFunktionÜberprüfen imBereichÜberprüfen alsGanzzahlÜberprüfen alsKarteÜberprüfen alsMixinÜberprüfen keineEinheitenÜberprüfen alsZahlÜberprüfen alsZeichenketteÜberprüfen alsEinheitÜberprüfen koErze koErzeZuEntsprechung koErzeWert koErzeWertZuEntsprechung verträglichMitEinheit konvertieren konvertierenZuEntsprechung konvertierenWert konvertierenWertZuEntsprechung gleich bekommen hatEinheit hashCode sassIndexZuListenIndex versucheKarte

Konstruktoren

constructor

  • Erstellt eine neue Zahl mit komplexeren Einheiten als nur einem Zähler.

    Bei der Konstruktion werden alle kompatiblen Zähler- und Nenner-Einheiten gemäß dem Umrechnungsfaktor zwischen ihnen vereinfacht.

    Parameter

    • wert: number

      Der numerische Wert der Zahl.

    • Optional einheit: string | {
          nennerEinheiten?: string[] | List<string>;
          zählerEinheiten?: string[] | List<string>;
      }

      Wenn dies eine Zeichenkette ist, wird sie als einzelne Zählereinheit für die Zahl verwendet.

    Gibt SassNumber zurück

Accessor

alsGanzzahl

  • get alsGanzzahl(): null | number

  • Wenn wert eine Ganzzahl gemäß istGanzzahl ist, gibt er wert gerundet auf diese Ganzzahl zurück. Wenn es keine Ganzzahl ist, wird null zurückgegeben.

    Gibt null | number zurück

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.

nennerEinheiten

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

hatEinheiten

  • get hatEinheiten(): boolean

  • Gibt es an, ob diese Zahl Zähler- oder Nenner-Einheiten hat.

    Gibt boolean zurück

istGanzzahl

isTruthy

  • get isTruthy(): boolean

  • Ob der Wert in einer @if-Anweisung und anderen Kontexten als true zählt.

    Gibt boolean zurück

zählerEinheiten

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

value

Methoden

assertBoolean

  • Wirft einen Fehler, wenn this kein SassBoolean ist.

    ⚠️ Vorsicht!

    Funktionen sollten generell isTruthy verwenden und keine booleschen Literale erzwingen.

    Parameter

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassBoolean zurück

assertCalculation

assertColor

assertFunction

imBereichÜberprüfen

  • Gibt wert zurück, wenn er innerhalb von min und max liegt. Wenn wert gleich min oder max gemäß der Sass-Gleichheit ist, wird min bzw. max zurückgegeben. Andernfalls wird ein Fehler ausgelöst.

    Parameter

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

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt number zurück

alsGanzzahlÜberprüfen

  • Wenn wert eine Ganzzahl gemäß istGanzzahl ist, gibt er sie gerundet auf diese Ganzzahl zurück. Andernfalls wird ein Fehler ausgelöst.

    Parameter

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt number zurück

assertMap

  • Wirft einen Fehler, wenn this kein SassMap ist.

    Parameter

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassMap zurück

assertMixin

keineEinheitenÜberprüfen

  • Wenn diese Zahl keine Einheiten hat, wird sie zurückgegeben. Andernfalls wird ein Fehler ausgelöst.

    Parameter

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassNumber zurück

assertNumber

assertString

alsEinheitÜberprüfen

  • Wenn diese Zahl einheit als einzige Einheit (und als Zähler) hat, wird diese Zahl zurückgegeben. Andernfalls wird ein Fehler ausgelöst.

    Parameter

    • einheit: string
    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassNumber zurück

koErze

  • Gibt eine Kopie dieser Zahl zurück, konvertiert in die Einheiten, die durch neueZähler und neueNenner dargestellt werden.

    Im Gegensatz zu konvertieren wird hier kein Fehler ausgelöst, wenn diese Zahl keine Einheit hat und entweder neueZähler oder neueNenner nicht leer sind oder umgekehrt. Stattdessen werden alle Einheitenlosen Zahlen als konvertierbar zu und von allen Einheiten behandelt, ohne den Wert zu ändern.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit neueZähler und neueNenner kompatibel sind.

    Parameter

    • neueZähler: string[] | List<string>

      Die Zählereinheiten, zu denen diese Zahl konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • neueNenner: string[] | List<string>

      Die Nenner-Einheiten, zu denen diese Zahl konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassNumber zurück

koErzeZuEntsprechung

  • Gibt eine Kopie dieser Zahl zurück, konvertiert in die Einheiten, die durch neueZähler und neueNenner dargestellt werden.

    Im Gegensatz zu konvertierenZuEntsprechung wird hier kein Fehler ausgelöst, wenn diese Zahl keine Einheit hat und entweder neueZähler oder neueNenner nicht leer sind oder umgekehrt. Stattdessen werden alle Einheitenlosen Zahlen als konvertierbar zu und von allen Einheiten behandelt, ohne den Wert zu ändern.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit den Einheiten von andere kompatibel sind.

    Parameter

    • andere: SassNumber
    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    • Optional andererName: string

      Der Name des Funktionsarguments, von dem andere stammt (ohne das $), wenn es von einem Argument stammt. Wird zur Fehlerbehandlung verwendet.

    Gibt SassNumber zurück

koErzeWert

  • Gibt wert zurück, konvertiert in die Einheiten, die durch neueZähler und neueNenner dargestellt werden.

    Im Gegensatz zu konvertierenWert wird hier kein Fehler ausgelöst, wenn diese Zahl keine Einheit hat und entweder neueZähler oder neueNenner nicht leer sind oder umgekehrt. Stattdessen werden alle Einheitenlosen Zahlen als konvertierbar zu und von allen Einheiten behandelt, ohne den Wert zu ändern.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit neueZähler und neueNenner kompatibel sind.

    Parameter

    • neueZähler: string[] | List<string>

      Die Zählereinheiten, zu denen wert konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • neueNenner: string[] | List<string>

      Die Nenner-Einheiten, zu denen wert konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt number zurück

koErzeWertZuEntsprechung

  • Gibt wert zurück, konvertiert in die Einheiten, die durch neueZähler und neueNenner dargestellt werden.

    Im Gegensatz zu konvertierenWertZuEntsprechung wird hier kein Fehler ausgelöst, wenn diese Zahl keine Einheit hat und entweder neueZähler oder neueNenner nicht leer sind oder umgekehrt. Stattdessen werden alle Einheitenlosen Zahlen als konvertierbar zu und von allen Einheiten behandelt, ohne den Wert zu ändern.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit den Einheiten von andere kompatibel sind.

    Parameter

    • andere: SassNumber
    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    • Optional andererName: string

      Der Name des Funktionsarguments, von dem andere stammt (ohne das $), wenn es von einem Argument stammt. Wird zur Fehlerbehandlung verwendet.

    Gibt number zurück

verträglichMitEinheit

  • Gibt es an, ob diese Zahl genau eine Zählereinheit hat und diese Einheit mit einheit kompatibel ist.

    Parameter

    • einheit: string

    Gibt boolean zurück

konvertieren

  • Gibt eine Kopie dieser Zahl zurück, konvertiert in die Einheiten, die durch neueZähler und neueNenner dargestellt werden.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit neueZähler und neueNenner kompatibel sind; oder wenn diese Zahl keine Einheit hat und entweder neueZähler oder neueNenner nicht leer sind oder umgekehrt.

    Parameter

    • neueZähler: string[] | List<string>

      Die Zählereinheiten, zu denen diese Zahl konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • neueNenner: string[] | List<string>

      Die Nenner-Einheiten, zu denen diese Zahl konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassNumber zurück

konvertierenZuEntsprechung

  • Gibt eine Kopie dieser Zahl zurück, konvertiert in die gleichen Einheiten wie andere.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit den Einheiten von andere kompatibel sind, oder wenn eine der Zahlen einheitenlos ist, die andere aber nicht.

    Parameter

    • andere: SassNumber
    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    • Optional andererName: string

      Der Name des Funktionsarguments, von dem andere stammt (ohne das $), wenn es von einem Argument stammt. Wird zur Fehlerbehandlung verwendet.

    Gibt SassNumber zurück

konvertierenWert

  • Gibt wert zurück, konvertiert in die Einheiten, die durch neueZähler und neueNenner dargestellt werden.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit neueZähler und neueNenner kompatibel sind; oder wenn diese Zahl keine Einheit hat und entweder neueZähler oder neueNenner nicht leer sind oder umgekehrt.

    Parameter

    • neueZähler: string[] | List<string>

      Die Zählereinheiten, zu denen wert konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • neueNenner: string[] | List<string>

      Die Nenner-Einheiten, zu denen wert konvertiert werden soll. Dies kann entweder ein einfaches JavaScript-Array oder eine unveränderliche Liste aus dem Paket immutable sein.

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt number zurück

convertValueToMatch

  • Gibt value zurück, konvertiert in dieselben Einheiten wie other.

    Wirft

    Fehler, wenn die Einheiten dieser Zahl nicht mit den Einheiten von andere kompatibel sind, oder wenn eine der Zahlen einheitenlos ist, die andere aber nicht.

    Parameter

    • andere: SassNumber
    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    • Optional andererName: string

      Der Name des Funktionsarguments, von dem andere stammt (ohne das $), wenn es von einem Argument stammt. Wird zur Fehlerbehandlung verwendet.

    Gibt number zurück

equals

get

  • Gibt den Wert am Index index in diesem Wert als Liste zurück, oder undefined, wenn index fü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

hasUnit

  • Prüft, ob diese Zahl unit als einzige Einheit hat (und als Zähler).

    Parameter

    • einheit: string

    Gibt boolean zurück

hashCode

sassIndexToListIndex

  • Konvertiert sassIndex in 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

    Error Wenn sassIndex keine 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.

    • Optional name: string

      Der Name des Arguments sassIndex (ohne das $), wenn es von einem Argument stammt. Wird für die Fehlerberichterstattung verwendet.

    Gibt number zurück

tryMap