Interface KuboNode

api

options

cleanup

• cleanup(args?): Promise<void>

• Perform any resource cleanup after stopping a disposable node

  Parameters

  • Optional args: unknown

  Returns Promise<void>

info

• info(): Promise<KuboInfo>

• Return information about a node

  Returns Promise<KuboInfo>

init

• init(args?): Promise<void>

• Perform any pre-start tasks such as creating a repo, generating a peer id, etc

  Parameters

  • Optional args: KuboInitOptions

  Returns Promise<void>

start

• start(args?): Promise<void>

• Start the node

  Parameters

  • Optional args: KuboStartOptions

  Returns Promise<void>

stop

• stop(args?): Promise<void>

• Stop a node that has previously been started

  Parameters

  • Optional args: KuboStopOptions

  Returns Promise<void>