> For the complete documentation index, see [llms.txt](https://docs.viesus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viesus.com/reference/node.js-module/overview.md).

# Overview

{% hint style="info" %}
**Linux Only**

The VIESUS Node.js module is available on **Linux only** (Ubuntu 22.04+).
{% endhint %}

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.

```powershell
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](/installation/requirements.md) for OS, Node.js, driver, and GPU requirements.

***

## Enhancement features

All features in the [Configuration Reference](/configuration/parameter-reference.md) 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](/operations/benchmarks.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.viesus.com/reference/node.js-module/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.