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

Mithilfe dieser JavaScript-Bibliothek können Sie Objekte, die das System löschen soll, sammeln und aufräumen. Die JavaScript-Bibliothek verwenden Sie in der Regel während automatisierten Tests, um alle anfallenden Objekte während eines Tests zu sammeln und nach dem Test wieder aufzuräumen.

Verwendung

---

Diese Bibliothek binden Sie stets am Anfang eines Skripts ein:

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

Funktionen

---

object

Merkt sich ein agorum core-Objekt zum späteren Löschen.

Syntax

object(objekt);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
objekt	Definiert ein Objekt in agorum core.	ja	–

Beispiel

let objects = require('common/object');
let cleaner = require('/agorum/roi/customers/agorum.dev/js/lib/cleaner')();

let object = objects.find('1234');
cleaner.object(object);

Verwendung

Diese Funktion verwenden Sie, wenn Sie sich ein Objekt zum späteren Aufräumen merken möchten.

workflowInstance

Merkt sich die komplette Workflow-Instanz, auch, wenn Sie Unterobjekte des Workflows übergeben, etwa ein Token-Objekt.

Syntax

workflowInstance(objekt);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
objekt	Definiert ein Workflow-Objekt in agorum core (Token, Log, process-Object).	ja	–

Beispiel

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

let token = workflow.tokens(workflow.start('agorum.workflow.task', {
  sys_acw_attachments: []
}))[0];

cleaner.object(token);

Verwendung

Diese Funktion verwenden Sie, wenn Sie den gesamten Workflow löschen möchten, auch wenn Sie etwa ein Token-Objekt davon übergeben.

clean

Löscht alle zuvor gemerkten Objekte.

Syntax

clean()

 

Beispiel

let objects = require('common/object');
let cleaner = require('/agorum/roi/customers/agorum.dev/js/lib/cleaner')();
let workflow = require('/agorum/roi/customers/agorum.dev/js/lib/workflow');

let token = workflow.tokens(workflow.start('agorum.workflow.task', {
  sys_acw_attachments: []
}))[0];

cleaner.object(token);

// ... 

let object = objects.find('1234');
cleaner.object(object);

// ...

cleaner.clean();

Verwendung

Diese Funktion verwenden Sie, wenn Sie alle gesammelten Objekte der cleaner-Instanz löschen möchten. Üblicherweise verwenden Sie diese Funktion im „after"-Skript eines Tests.