For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

The VIESUS Node.js native module integrates the VIESUS image enhancement engine into Node.js environments on Linux. Overview, architecture, and requirements.

Linux Only

The VIESUS Node.js module is available on Linux only (Ubuntu 22.04+).

The VIESUS Node.js module is a native C++ addon that integrates the VIESUS enhancement engine directly into Node.js processes. It is designed for web servers, REST APIs, and SaaS platforms that enhance images on upload without spawning external processes.


How it works

The module exposes a synchronous Enhance() call that runs inside worker threads. A static thread pool manages multiple workers in parallel; each worker holds a persistent VIESUS instance. The main Node.js event loop stays unblocked while images process concurrently.

Main Thread (event loop — non-blocking)
    └── StaticPool
            ├── Worker 1 → VIESUS instance → Enhance()
            ├── Worker 2 → VIESUS instance → Enhance()
            ├── Worker 3 → VIESUS instance → Enhance()
            └── Worker N → VIESUS instance → Enhance()

Scaling is straightforward: set the pool size to the number of CPU cores (for CPU processing) or the number of NVIDIA GPUs (for GPU-accelerated processing).


Requirements

See System Requirements for OS, Node.js, driver, and GPU requirements.


Enhancement features

All features in the Configuration Reference are available. The same viesusini.json used with the CLI works with the Node.js module.


Performance

For measured throughput (CPU-pool benchmarks, single-image latency) and the module's scaling characteristics, see Benchmarks.

Last updated

Was this helpful?