Better doclines

This commit is contained in:
Iván Ovejero 2024-11-07 14:02:52 +01:00
parent b3db0c8a93
commit b07171022e
No known key found for this signature in database
2 changed files with 13 additions and 6 deletions

View file

@ -1,10 +1,17 @@
import { Config, Env } from '../decorators'; import { Config, Env } from '../decorators';
/** /**
* Whether to enable task runners and how to run them * Modes for running a task runner:
* - internal_childprocess: Task runners are run as a child process and launched by n8n *
* - internal_launcher: Task runners are run as a child process and launched by n8n using a separate launch program * - In `internal_childprocess` mode, n8n launches a task runner as a child
* - external: Task runners are run as a separate program not launched by n8n * process and manages its lifecycle.
* - In `internal_launcher` mode, n8n runs an executable that launches a task
* runner as a child process and manages its lifecycle.
* - In `external` mode, n8n does not launch the runner or manage its lifecycle.
* Rather, a third party launches the runner separately from n8n.
*
* Lifecycle management means that n8n launches the task runner only when needed
* and shuts it down when the task runner has been idle for too long.
*/ */
export type TaskRunnerMode = 'internal_childprocess' | 'internal_launcher' | 'external'; export type TaskRunnerMode = 'internal_childprocess' | 'internal_launcher' | 'external';

View file

@ -17,8 +17,8 @@ export type RunnerLifecycleEventMap = {
export class RunnerLifecycleEvents extends TypedEmitter<RunnerLifecycleEventMap> {} export class RunnerLifecycleEvents extends TypedEmitter<RunnerLifecycleEventMap> {}
/** /**
* Responsible for launching a task runner if none available * Responsible for launching a task runner if none available and shutting it down
* and shutting it down if idle for too long. * if idle for too long. Only for `internal_childprocess` and `internal_launcher` modes.
*/ */
@Service() @Service()
export class RunnerLifecycleManager { export class RunnerLifecycleManager {