Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface API<OptionExtension>

Type parameters

  • OptionExtension = {}

Hierarchy

  • API

Index

Properties

Methods

Properties

profiles

profiles: API<{}>

Methods

get

  • get(key: string, options?: AbortOptions & OptionExtension): Promise<string | object>

  • Returns a value from the currently being used config. If the daemon is off, it returns the value from the stored config.

    Parameters

    Returns Promise<string | object>

getAll

  • Returns the full config been used. If the daemon is off, it returns the stored config

    Parameters

    Returns Promise<Config>

replace

  • Replaces the full config. Note that restarting the node will be necessary for any change to take effect.

    Parameters

    Returns Promise<void>

set

  • set(key: string, value: any, options?: AbortOptions & OptionExtension): Promise<void>

  • Adds or replaces a config value. Note that restarting the node will be necessary for any change to take effect.

    Parameters

    • key: string
    • value: any
    • Optional options: AbortOptions & OptionExtension

    Returns Promise<void>

Generated using TypeDoc