Skip to main content

​
Overview

The generator orchestration system manages the execution of documentation generators in dependency order, with support for parallel processing and streaming results.

​
createGenerator

Creates a generator orchestration system that schedules and executes generators. 
import createGenerator from './generators.mjs';

const { runGenerators } = createGenerator();

​
Returns

​
runGenerators
function
required
Function to execute generators with configuration

​
runGenerators

Runs all requested generators with their dependencies in the correct order. 
const results = await runGenerators(configuration);

​
Parameters

​
configuration
Configuration
required
Runtime configuration object containing:

​
Returns

​
results
unknown[]
Array of results from all requested generators, in the same order as the target array

​
Example

import createGenerator from './generators.mjs';
import { setConfig } from './utils/configuration/index.mjs';

const { runGenerators } = createGenerator();

// Set up configuration
const config = await setConfig({
  input: 'doc/api/*.md',
  output: 'dist/',
  target: ['metadata', 'json-simple'],
  threads: 4,
  version: '20.0.0',
});

// Run generators
const results = await runGenerators(config);

​
Generator Execution Flow

The orchestration system:
  1. Schedules generators - Analyzes dependencies and schedules generators in the correct order
  2. Creates worker pool - Initializes a worker thread pool based on the threads configuration
  3. Executes generators - Runs generators, waiting for dependencies to complete first
  4. Handles streaming - For generators that yield results, collects streaming output
  5. Parallel processing - Creates parallel workers for generators with hasParallelProcessor: true
  6. Returns results - Returns all generator outputs in the requested order

​
Internal Methods

​
scheduleGenerator

Internal method that schedules a generator and its dependencies for execution. Source: generators.mjs:51

​
getDependencyInput

Retrieves the collected input from a dependency generator, handling both regular and streaming results. Source: generators.mjs:31

Build docs developers (and LLMs) love

Get started for freeTalk to us