@hashgraph/solo
    Preparing search index...

    Interface ConfigMutator

    Implementations of config mutator provide the necessary methods to access and modify a configuration.

    interface ConfigMutator {
        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>;
        putObject<T>(key: string, value: T): void;
        putObjectArray<T>(key: string, value: T[]): void;
        putScalar(key: string, value: Primitive): void;
        putScalarArray(key: string, value: Primitive[]): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    asBoolean asNumber asObject asObjectArray asString asStringArray properties propertyNames putObject putObjectArray putScalar putScalarArray

    Methods

    • 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.

    • Puts an object value into the configuration.

      Type Parameters

      • T

      Parameters

      • key: string

        The key to use to store the value in the configuration.

      • value: T

        The value to store in the configuration.

      Returns void

    • Puts an array of object values into the configuration.

      Type Parameters

      • T

      Parameters

      • key: string

        The key to use to store the values in the configuration.

      • value: T[]

        The values to store in the configuration.

      Returns void

    • Puts an array of string, boolean or numeric values into the configuration.

      Parameters

      • key: string

        The key to use to store the values in the configuration.

      • value: Primitive[]

        The values to store in the configuration.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods