n8n-io-task-runner-launcher

Namespace

n8n-io-task-runner-launcher

Description:
  • Optimize resource use with the Task Runner Launcher, a CLI tool that powers on-demand n8n task execution. Ensure efficiency and resilience in task management while keeping system operations seamless.

Author:

Methods

(async, static) createN8nIoTaskRunnerLauncherInstance(context, body) → {N8nIoTaskRunnerLauncher}

Description:
  • Create a new n8n runner instance

Example
import { Context } from '@osaas/client-core';
import { createN8nIoTaskRunnerLauncherInstance } from '@osaas/client-services';

const ctx = new Context();
const body: N8nIoTaskRunnerLauncherConfig = { name: 'myinstance', ... };
const instance = await createN8nIoTaskRunnerLauncherInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body N8nIoTaskRunnerLauncherConfig

Service instance configuration

Returns:
  • Service instance
Type
N8nIoTaskRunnerLauncher

(async, static) getN8nIoTaskRunnerLauncherInstance(context, name) → {N8nIoTaskRunnerLauncher}

Description:
  • Get a n8n runner instance

Example
import { Context } from '@osaas/client-core';
import { getN8nIoTaskRunnerLauncherInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getN8nIoTaskRunnerLauncherInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the runner to be retrieved

Returns:
  • Service instance
Type
N8nIoTaskRunnerLauncher

(async, static) removeN8nIoTaskRunnerLauncherInstance(context, name)

Description:
  • Remove a n8n runner instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the runner to be removed