Interface KuboOptions

interface KuboOptions {
    args?: string[];
    bin?: string;
    clean?: unknown;
    disposable?: boolean;
    endpoint?: string;
    env?: Record<string, string>;
    init?: boolean | KuboInitOptions;
    repo?: string;
    start?: boolean | KuboStartOptions;
    stop?: KuboStopOptions;
    test?: boolean;
    type: "kubo";
    rpc?(...args): KuboRPCClient;
}

Hierarchy (view full)

Properties

args? bin? clean? disposable? endpoint? env? init? repo? start? stop? test? type

Methods

rpc?

Properties

Optional args

args?: string[]

Custom cli args

Optional bin

bin?: string

Path to a Kubo executable

Optional clean

clean?: unknown

Clean options

Optional disposable

disposable?: boolean

A new repo is created and initialized for each invocation, as well as cleaned up automatically once the process exits

Optional endpoint

endpoint?: string

Where applicable, this endpoint will be used to spawn nodes remotely

Default

http://127.0.0.1:43134

Optional env

env?: Record<string, string>

Additional environment variables, passed to executing shell. Only applies for Daemon controllers

Optional init

init?: boolean | KuboInitOptions

Init options

Optional repo

repo?: string

The path to a repo directory. It will be created during init if it does not already exist.

Optional start

start?: boolean | KuboStartOptions

Start options

Optional stop

stop?: KuboStopOptions

Stop options

Optional test

test?: boolean

Flag to activate custom config for tests

type

type: "kubo"

The type of controller

Methods

Optional rpc

Settings

Member Visibility

Theme

On This Page

argsbincleandisposableendpointenvinitrepostartstoptesttyperpc