Interface KuboNode

api

options

cleanup

• cleanup(args?: unknown): Promise<void>

  Perform any resource cleanup after stopping a disposable node

  Parameters

  • Optionalargs: unknown

  Returns Promise<void>

info

• info(): Promise<KuboInfo>

  Return information about a node

  Returns Promise<KuboInfo>

init

• init(args?: KuboInitOptions): Promise<void>

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

  Parameters

  • Optionalargs: KuboInitOptions

  Returns Promise<void>

start

• start(args?: KuboStartOptions): Promise<void>

  Start the node

  Parameters

  • Optionalargs: KuboStartOptions

  Returns Promise<void>

stop

• stop(args?: KuboStopOptions): Promise<void>

  Stop a node that has previously been started

  Parameters

  • Optionalargs: KuboStopOptions

  Returns Promise<void>