@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface KeyValueService

    Service providing keystore functionality for the CLI. The keystore data is scoped to the service or Command instances accessing this service via Context.getServiceById.

    Values are arbitrary JSON-serializable data (see ValueNode) - not limited to strings - and may be deep objects or arrays.

    Any node within a value passed to set can be wrapped in Secret to have that node - and only that node - stored as an OS-native secret via SecretService, with a sentinel reference (prefixed with __SECRET__:) kept in its place in the stored structure. Everything else in the value is stored as plain (unencrypted) config data. This is symmetric with get, which resolves sentinel references found at any depth.

    interface KeyValueService {
        delete(key: string): Promise<void>;
        get<T extends ValueNode = ValueNode>(key: string): Promise<T>;
        has(key: string): Promise<boolean>;
        set(key: string, value: SettableValueNode): Promise<void>;
    }

    Implemented by

    Index
    delete get has set

    • Delete the value for a specified key in the keystore.

      Recursively walks the stored (unresolved) structure for key and deletes every OS-native secret referenced - at any depth - via SecretService, before removing the key itself.

      Parameters

      • key: string

      Returns Promise<void>

    • Get the value for a specified key in the keystore.

      Recursively resolves any string leaf - at any depth within the stored value - which is a secret sentinel, retrieving its actual value via SecretService. This covers both values written via set using a nested Secret, and secret references a user hand-embeds directly (nested arbitrarily deep) in the CLI's JSON config file.

      Type Parameters

      • T extends ValueNode = ValueNode

      Parameters

      • key: string

      Returns Promise<T>

    • Check if a value for a specified key exists in the keystore.

      Parameters

      • key: string

      Returns Promise<boolean>

    • Set a value for a specified key in the keystore.

      Any node within value wrapped in Secret - at any depth - is serialized as JSON and stored as an OS-native secret via SecretService, with a sentinel reference kept in its place in the stored structure. All other data is stored as plain (unencrypted) config data. Storing a secret requires that the service was constructed with secret support enabled.

      Parameters

      • key: string
      • value: SettableValueNode

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods