Modul:Common/Doku

From Star Citizen Wiki

This is the documentation page for Modul:Common

Dokumentations-Unterseite Diese Seite ist die Dokumentations-Unterseite der Modul:Common/Doku.
Dieses Modul wurde bis jetzt noch nicht dokumentiert. Bitte erstelle eine die Dokumentation hier: Modul:Common/Doku/Doku

Modulabhängigkeiten

Dieses Modul benötigt keine anderen Module.

Modulinfo

Das Modul Common stellt Funktionen bereit, welche allgemein in anderen Modulen weiterverwendet werden.

Öffentliche Methoden

Das Modul stellt folgende öffentliche Methoden bereit:

  • extractDataFromPrefix
    • Extrahiert alle Argumente, die mit 'argPrefix' beginnen, aus übergebenen Vorlageparametern
  • setDisplayTitle
    • Setzt den Abzeigetitel der aktuellen Seite
      • framm tabelle: Der zu bearbeitende Frame
      • title string: Seitentitel
      • flag string: Entweder 'noerror' oder 'noreplace'
  • removeTypeSuffix
    • Entfernt (...) Suffixe aus einer Zeichenkette
      • Beispiel:
        • Eingabe: Orion (Raumschiff)
        • Aufruf: common.removeTypeSuffix( 'Orion (Raumschiff)', 'Raumschiff' )
        • Ausgabe: Orion
  • checkSmwResult
    • Prüft, ob das Setzen von SMW-Daten erfolgreich war
  • checkApiResponse
    • Prüft, ob die Api-Anfrage erfolgreich war und ob die Antwort gültig ist
  • toNumber
    • Konvertiert eine Eingabe zu einer Zahl
  • formatNum
    • Formatiert eine Zahl entsprechend der Sprache des Inhalts
  • getImage
    • Findet das erste vorhandene Bild für die aktuelle Seite oder angegebene Namen
  • booleanToText
    • Ausgabe einer Zeichenkette basierend auf dem wahrheitsgemäßen Eingangswert
  • spairs
    • Sortiertes pairs
  • mapTranslation
    • Mapt { de_DE: '...', en_EN: '...' } zu einem Format was Semantic Media Wiki versteht
  • getLocaleForPage
    • Gibt den Sprachcode der aktuellen Seite zurück

Tests

✔ Alle Tests bestanden.

Name Expected Actual
testBooleanToTextFalseish
testBooleanToTextFalseishCustomText
testBooleanToTextTrueish
testExtractPrefixNumerical
testExtractPrefixNumericalEmpty
testFormatNum
testFormatNumberString
testFormatNumberStringFail
testRemoveTypeSuffix
testRemoveTypeSuffixNoMatch
testToNumberNum
testToNumberString
testToNumberStringFail
Cookies help us deliver our services. By using our services, you agree to our use of cookies.