Interface Factory<DefaultNode>

interface Factory<DefaultNode> {
    controllers: Node<unknown, NodeOptions<unknown, unknown, unknown, unknown>, Record<string, any>, unknown, unknown, unknown, unknown>[];
    options: NodeOptions<unknown, unknown, unknown, unknown>;
    overrides: NodeOptionsOverrides;
    clean(): Promise<void>;
    spawn(options?): Promise<KuboNode>;
    spawn(options?): Promise<DefaultNode>;
}

Type Parameters

DefaultNode extends Node = Node

Index

Properties

controllers options overrides

Methods

Properties

controllers

controllers: Node<unknown, NodeOptions<unknown, unknown, unknown, unknown>, Record<string, any>, unknown, unknown, unknown, unknown>[]

The previously created nodes that are still running

options

options: NodeOptions<unknown, unknown, unknown, unknown>

The default options that will be applied to all nodes

overrides

overrides: NodeOptionsOverrides

Config overrides that will be applied to specific node types

Methods

clean

clean(): Promise<void>
Shut down all previously created nodes that are still running

Returns Promise<void>
- Defined in index.ts:238

spawn

spawn(options?): Promise<KuboNode>
Create a node
Parameters
- Optional options: KuboOptions & SpawnOptions
Returns Promise<KuboNode>
- Defined in index.ts:232
spawn(options?): Promise<DefaultNode>
Parameters
- Optional options: NodeOptions<unknown, unknown, unknown, unknown> & SpawnOptions
Returns Promise<DefaultNode>
- Defined in index.ts:233