JavaScript-Bibliothek agorum.dev/js/lib/assert

Mithilfe dieser JavaScript-Bibliothek überprüfen Sie erwartete Ergebnisse.

Verwendung

---

Diese Bibliothek binden Sie stets am Anfang eines Skripts ein:

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

Instanziierung

---

Sie instanziieren diese Bibliothek stets mit einem Namen:

assert('Sprechender Name der Prüfung').Funktion(....)

Funktionen

---

fail

Deklariert die Prüfung als fehlgeschlagen.

Syntax

fail();

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

assert('Abbruch').fail();

Verwendung

Diese Funktion verwenden Sie, wenn Sie manuell einen Fehler auslösen möchten.

Exceptions

Diese Funktion wirft direkt einen Fehler.

isDefined

Prüft, ob der übergebene Wert defined ist.

Syntax

isDefined(value);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
value	Definiert den zu prüfenden Wert.	ja	–

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

let value = 'xyz';
assert('Ist definiert').isDefined(value);

Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob der übergebene Wert definiert ist.

Exceptions

Das System wirft eine Exception, wenn der übergebene Wert undefined ist.

isTruthy

Prüft, ob der übergebene Wert truthy ist.

Syntax

isTruthy(value);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
value	Definiert den zu prüfenden Wert.	ja	–

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

let value = 'xyz';
assert('Ist definiert').isTruthy(value);

Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen wollen, ob der übergebene Wert truthy ist (NICHT: undefined, false, '').

Exceptions

Das System wirft eine Exception, wenn der übergebene Wert nicht truthy ist.

isFalsy

Prüft, ob der übergebene Wert falsy ist.

Syntax

isFalsy(value);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
value	Definiert den zu prüfenden Wert.	ja	–

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

let value = '';
assert('Ist definiert').isFalsy(value);

Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob der übergebene Wert falsy ist (etwa: undefined, false, '').

Exceptions

Das System wirft eine Exception, wenn der übergebene Wert nicht falsy ist.

isTrue

Prüft, ob der übergebene Wert true ist.

Syntax

isTrue(value);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
value	Definiert den zu prüfenden Wert.	ja	–

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

let value = true;
assert('Ist true').isTrue(value);

Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob der übergebene Wert true ist.

Exceptions

Das System wirft einen Fehler, wenn der übergebene Wert nicht true ist.

isFalse

Prüft, ob der übergebene Wert false ist.

Syntax

isFalse(value);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
value	Definiert den zu prüfenden Wert.	ja	–

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

let value = false;
assert('Ist false').isFalse(value);

Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen wollen, ob der übergebene Wert false ist.

Exceptions

Das System wirft eine Exception, wenn der übergebene Wert nicht false ist.

isEqual

Prüft, ob die übergebenen Werte gleich sind.

Syntax

isEqual(expected, value);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
expected	Definiert den zu erwartenden Wert.	ja	–
value	Definiert den zu prüfenden Wert.	ja	–

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

let value = 'xyz';
assert('Ist gleich').isEqual('xyz', value);

Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob der übergebene Wert dem erwarteten Wert entspricht.

Exceptions

Das System wirft eine Exception, wenn die Werte nicht übereinstimmen.

hasValues

Prüft, ob der übergebene Wert (JavaScript-Objekt) die erwarteten Werte enthält.

Syntax

hasValues(expected, value);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
expected	Definiert eine JS-Objekt-Struktur mit den zu erwartenden Werten.	ja	–
value	Definiert eine JS-Objekt-Struktur mit den zu prüfenden Werten.	ja	–

Beispiel

let assert = require('/agorum/roi/customers/agorum.dev/js/lib/assert');

let value = {
  value1: '123',
  value2: 456,
  value3: true,
  value4: 'noch mehr'
};
assert('Beinhaltet erwartete Werte').hasValues({
  value1: '123',
  value2: 456,
  value3: true
}, value);

Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob in dem zu prüfenden Value die Werte vorkommen, die Sie in expected erwarten.

Exceptions

Das System wirft eine Exception, wenn die Werte nicht korrekt vorkommen.