Function getEnv

  • Reads the environment variables from process.env and performs the checks against the shared constraints to ensure the required configuration is provided through the environment variables.

    Returns

    A NodeJS.ProcessEnv like object which respects the shared constraints

    Type Parameters

    • V extends readonly ("ADDRESS_DISCOVERY" | "ARRIVAL_PHASE_DURATION_IN_SECS" | "DB_SYNC_CONNECTION_STRING" | "KEY_MANAGEMENT_PARAMS" | "KEY_MANAGEMENT_PROVIDER" | "LOGGER_MIN_SEVERITY" | "NETWORK_SPEED" | "OGMIOS_URL" | "STAKE_POOL_CONNECTION_STRING" | "STAKE_POOL_TEST_CONNECTION_STRING" | "START_LOCAL_HTTP_SERVER" | "TEST_CLIENT_ASSET_PROVIDER" | "TEST_CLIENT_ASSET_PROVIDER_PARAMS" | "TEST_CLIENT_CHAIN_HISTORY_PROVIDER" | "TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS" | "TEST_CLIENT_HANDLE_PROVIDER" | "TEST_CLIENT_HANDLE_PROVIDER_PARAMS" | "TEST_CLIENT_NETWORK_INFO_PROVIDER" | "TEST_CLIENT_NETWORK_INFO_PROVIDER_PARAMS" | "TEST_CLIENT_REWARDS_PROVIDER" | "TEST_CLIENT_REWARDS_PROVIDER_PARAMS" | "TEST_CLIENT_STAKE_POOL_PROVIDER" | "TEST_CLIENT_STAKE_POOL_PROVIDER_PARAMS" | "TEST_CLIENT_TX_SUBMIT_PROVIDER" | "TEST_CLIENT_TX_SUBMIT_PROVIDER_PARAMS" | "TEST_CLIENT_UTXO_PROVIDER" | "TEST_CLIENT_UTXO_PROVIDER_PARAMS" | "TRANSACTIONS_NUMBER" | "TX_SUBMIT_HTTP_URL" | "VIRTUAL_USERS_COUNT" | "VIRTUAL_USERS_GENERATE_DURATION" | "WALLET_SYNC_TIMEOUT_IN_MS" | "WORKER_PARALLEL_TRANSACTION" | "WS_PROVIDER_URL")[]

    Parameters

    • variables: V

      Array of the names of the required variables

    • options: {
          default?: ProcessEnv;
          override?: ProcessEnv;
      } = {}

      Options to customize the behavior

      • Optional default?: ProcessEnv

        Object of default values

      • Optional override?: ProcessEnv

        Object of override values

    Returns { [ v in "ADDRESS_DISCOVERY" | "ARRIVAL_PHASE_DURATION_IN_SECS" | "DB_SYNC_CONNECTION_STRING" | "KEY_MANAGEMENT_PARAMS" | "KEY_MANAGEMENT_PROVIDER" | "LOGGER_MIN_SEVERITY" | "NETWORK_SPEED" | "OGMIOS_URL" | "STAKE_POOL_CONNECTION_STRING" | "STAKE_POOL_TEST_CONNECTION_STRING" | "START_LOCAL_HTTP_SERVER" | "TEST_CLIENT_ASSET_PROVIDER" | "TEST_CLIENT_ASSET_PROVIDER_PARAMS" | "TEST_CLIENT_CHAIN_HISTORY_PROVIDER" | "TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS" | "TEST_CLIENT_HANDLE_PROVIDER" | "TEST_CLIENT_HANDLE_PROVIDER_PARAMS" | "TEST_CLIENT_NETWORK_INFO_PROVIDER" | "TEST_CLIENT_NETWORK_INFO_PROVIDER_PARAMS" | "TEST_CLIENT_REWARDS_PROVIDER" | "TEST_CLIENT_REWARDS_PROVIDER_PARAMS" | "TEST_CLIENT_STAKE_POOL_PROVIDER" | "TEST_CLIENT_STAKE_POOL_PROVIDER_PARAMS" | "TEST_CLIENT_TX_SUBMIT_PROVIDER" | "TEST_CLIENT_TX_SUBMIT_PROVIDER_PARAMS" | "TEST_CLIENT_UTXO_PROVIDER" | "TEST_CLIENT_UTXO_PROVIDER_PARAMS" | "TRANSACTIONS_NUMBER" | "TX_SUBMIT_HTTP_URL" | "VIRTUAL_USERS_COUNT" | "VIRTUAL_USERS_GENERATE_DURATION" | "WALLET_SYNC_TIMEOUT_IN_MS" | "WORKER_PARALLEL_TRANSACTION" | "WS_PROVIDER_URL"]: {
        ADDRESS_DISCOVERY: ValidatorSpec<string>;
        ARRIVAL_PHASE_DURATION_IN_SECS: ValidatorSpec<number>;
        DB_SYNC_CONNECTION_STRING: ValidatorSpec<string>;
        KEY_MANAGEMENT_PARAMS: ValidatorSpec<KeyManagementParams>;
        KEY_MANAGEMENT_PROVIDER: ValidatorSpec<string>;
        LOGGER_MIN_SEVERITY: ValidatorSpec<string>;
        NETWORK_SPEED: ValidatorSpec<"fast" | "slow">;
        OGMIOS_URL: ValidatorSpec<string>;
        STAKE_POOL_CONNECTION_STRING: ValidatorSpec<string>;
        STAKE_POOL_TEST_CONNECTION_STRING: ValidatorSpec<string>;
        START_LOCAL_HTTP_SERVER: ValidatorSpec<boolean>;
        TEST_CLIENT_ASSET_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_ASSET_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TEST_CLIENT_CHAIN_HISTORY_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TEST_CLIENT_HANDLE_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_HANDLE_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TEST_CLIENT_NETWORK_INFO_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_NETWORK_INFO_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TEST_CLIENT_REWARDS_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_REWARDS_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TEST_CLIENT_STAKE_POOL_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_STAKE_POOL_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TEST_CLIENT_TX_SUBMIT_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_TX_SUBMIT_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TEST_CLIENT_UTXO_PROVIDER: ValidatorSpec<string>;
        TEST_CLIENT_UTXO_PROVIDER_PARAMS: ValidatorSpec<ProviderParams>;
        TRANSACTIONS_NUMBER: ValidatorSpec<number>;
        TX_SUBMIT_HTTP_URL: ValidatorSpec<string>;
        VIRTUAL_USERS_COUNT: ValidatorSpec<number>;
        VIRTUAL_USERS_GENERATE_DURATION: ValidatorSpec<number>;
        WALLET_SYNC_TIMEOUT_IN_MS: ValidatorSpec<number>;
        WORKER_PARALLEL_TRANSACTION: ValidatorSpec<number>;
        WS_PROVIDER_URL: ValidatorSpec<string>;
    }[v] extends ValidatorSpec<T> ? T : never }

Settings

Member Visibility

Theme

Generated using TypeDoc