@hashgraph/solo
    Preparing search index...

    Interface ModelConfigSource<T>

    A configuration source defines the methods for reading configuration data from a configuration source. ConfigSource instances provide read-only access to configuration data.

    Represents a configuration file from a file system storage backend, the contents of the shell environment, the contents of a key within a configuration map, or the contents of a key with a secret.

    interface ModelConfigSource<T> {
        backend: StorageBackend;
        modelData: T;
        name: string;
        ordinal: number;
        prefix?: string;
        schema: Schema<T>;
        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[];
        load(): Promise<void>;
        properties(): Map<string, string>;
        propertyNames(): Set<string>;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Properties

    backend modelData name ordinal prefix? schema

    Methods

    asBoolean asNumber asObject asObjectArray asString asStringArray load properties propertyNames

    Properties

    backend: StorageBackend

    The backend that is used to read and write configuration data.

    modelData: T

    The model data that was read from the configuration source.

    name: string

    The name of the configuration source.

    ordinal: number

    The ordinal of the configuration source.

    prefix?: string

    An optional prefix that is used to filter configuration keys that are read from the configuration source.

    schema: Schema<T>

    The schema that defines the structure of the model.

    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.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods