Interface Node<API, Options, Info, InitArgs, StartArgs, StopArgs, CleanupArgs>

interface Node<
    API = unknown,
    Options = NodeOptions,
    Info extends Record<string, any> = Record<string, any>,
    InitArgs = unknown,
    StartArgs = unknown,
    StopArgs = unknown,
    CleanupArgs = unknown,
> {
    api: API;
    options: Options;
    cleanup(args?: CleanupArgs): Promise<void>;
    info(): Promise<Info>;
    init(args?: InitArgs): Promise<void>;
    start(args?: StartArgs): Promise<void>;
    stop(args?: StopArgs): Promise<void>;
}

Type Parameters

API = unknown
Options = NodeOptions
Info extends Record<string, any> = Record<string, any>
InitArgs = unknown
StartArgs = unknown
StopArgs = unknown
CleanupArgs = unknown

Hierarchy (View Summary)

Node
- KuboNode

Index

Properties

Methods

cleanup info init start stop

Properties

api

api: API

options

options: Options

Methods

cleanup

cleanup(args?: CleanupArgs): Promise<void>
Perform any resource cleanup after stopping a disposable node
Parameters
- Optionalargs: CleanupArgs
Returns Promise<void>
- Defined in index.ts:158

info

info(): Promise<Info>
Return information about a node

Returns Promise<Info>
- Defined in index.ts:137

init

init(args?: InitArgs): Promise<void>
Perform any pre-start tasks such as creating a repo, generating a peer id, etc
Parameters
- Optionalargs: InitArgs
Returns Promise<void>
- Defined in index.ts:143

start

start(args?: StartArgs): Promise<void>
Start the node
Parameters
- Optionalargs: StartArgs
Returns Promise<void>
- Defined in index.ts:148

stop

stop(args?: StopArgs): Promise<void>
Stop a node that has previously been started
Parameters
- Optionalargs: StopArgs
Returns Promise<void>
- Defined in index.ts:153