ipfsd-ctl
    Preparing search index...

    Interface NodeOptions<InitOptions, StartOptions, StopOptions, CleanOptions>

    interface NodeOptions<
        InitOptions = unknown,
        StartOptions = unknown,
        StopOptions = unknown,
        CleanOptions = unknown,
    > {
        args?: string[];
        clean?: CleanOptions;
        disposable?: boolean;
        endpoint?: string;
        env?: Record<string, string>;
        init?: InitOptions;
        start?: StartOptions;
        stop?: StopOptions;
        test?: boolean;
        type?: "kubo";
    }

    Type Parameters

    • InitOptions = unknown
    • StartOptions = unknown
    • StopOptions = unknown
    • CleanOptions = unknown

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    args?: string[]

    Custom cli args

    clean?: CleanOptions

    Clean options

    disposable?: boolean

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

    endpoint?: string

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

    http://127.0.0.1:43134
    env?: Record<string, string>

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

    init?: InitOptions

    Init options

    start?: StartOptions

    Start options

    stop?: StopOptions

    Stop options

    test?: boolean

    Flag to activate custom config for tests

    type?: "kubo"

    The type of controller

    Settings

    Member Visibility

    On This Page

    Properties