clean-jsdoc-theme API

Globals


Instance Methods

defineTask(id, run, priority) -> Task

Define a Task without writing the object literal by hand.

A convenience global that mirrors the createCache factory — handy for one-liners.

Parameters

  • id (string) — Stable task identifier.
  • run (TaskHandler) — The work to perform.
  • priority (Priority, optional, default: "Priority.NORMAL") — Scheduling weight.

Returns

  • Task — The assembled task.

Example

Define and enqueue a task

CODE
const task = defineTask('reindex', async () => rebuildIndex());
queue.push(task);
  • See:
    • Queue#push

Enums

LogLevel

enumreadonly
globals.js:19

Severity levels for Forge's logger — a global numeric enum, rendered as a member table in the Globals page section.

Properties

  • DEBUG (number, default: 10) — Diagnostic detail.
  • INFO (number, default: 20) — Normal operation.
  • WARN (number, default: 30) — Something looks off.
  • ERROR (number, default: 40) — A failure occurred.

Other

DEFAULT_OPTIONS

Default options applied to every Queue when none are supplied.

Properties

  • concurrency (number) — Default parallelism.
  • autoStart (boolean) — Whether to drain on push.