@hashgraph/solo
    Preparing search index...

    Interface Config

    Represents a single application wide multi-layer configuration.

    interface Config {
        sources: ConfigSource[];
        addSource(source: ConfigSource): void;
        asBoolean(key: string): boolean;
        asNumber(key: string): number;
        asObject<T>(cls: ClassConstructor<T>, key?: string): T;
        asObjectArray<T extends T[]>(cls: ClassConstructor<T>, key: string): T[];
        asString(key: string): string;
        asStringArray(key: string): string[];
        properties(): Map<string, string>;
        propertyNames(): Set<string>;
        refresh(): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    sources

    Methods

    addSource asBoolean asNumber asObject asObjectArray asString asStringArray properties propertyNames refresh

    Properties

    sources: ConfigSource[]

    All the configuration sources which were used to build this configuration.

    Methods

    • Adds a configuration source to the configuration.

      This method is not guaranteed to be thread-safe, so it should not be called concurrently with other methods that modify the configuration. Methods which read the configuration may be called concurrently, but may not reflect changes made by this method.

      This method is typically used to add configuration sources that have been created or loaded dynamically, such as configuration files, environment variables, or other sources of configuration data.

      The same ConfigSource instance can only be added once. If the same source is added again, a DuplicateConfigSourceError will be thrown. This is to ensure that each configuration source is unique within the configuration.

      A ConfigSource with the same name and ordinal as an existing source will be considered a duplicate, even if it is a different instance.

      Parameters

      Returns void

      if the configuration source has already been added.

    • Retrieves the value of the specified key from the configuration source and converts it to a boolean.

      Parameters

      • key: string

        The key to use to retrieve the value from the configuration source.

      Returns boolean

      The value of the specified key as a boolean.

    • Retrieves the value of the specified key from the configuration source and converts it to a number.

      Parameters

      • key: string

        The key to use to retrieve the value from the configuration source.

      Returns number

      The value of the specified key as a number.

    • Retrieves the value of the specified key from the configuration source and converts it an object of the specified type. If the key is not specified, the method returns the entire configuration as an object.

      Type Parameters

      • T

      Parameters

      • cls: ClassConstructor<T>

        The class of the object to which the value should be converted.

      • Optionalkey: string

        The key to use to retrieve the value from the configuration source.

      Returns T

      The value of the specified key as a boolean.

    • Retrieves the value of the specified key from the configuration source and converts it to an array of objects of the specified type. If the key is not specified, the method returns the entire configuration as an array of objects.

      Type Parameters

      • T extends T[]

      Parameters

      • cls: ClassConstructor<T>

        The class of the objects to which the values should be converted.

      • key: string

        The key to use to retrieve the values from the configuration source.

      Returns T[]

    • Retrieves the value of the specified key from the configuration source and converts it to a string.

      Parameters

      • key: string

        The key to use to retrieve the value from the configuration source.

      Returns string

      The value of the specified key as a string.

    • Retrieves the value of the specified key from the configuration source and converts it to a string array.

      Parameters

      • key: string

        The key to use to retrieve the value from the configuration source.

      Returns string[]

      The value of the specified key as a string array.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods