Preparing search index...
The search index is not available cardano-sdk
get Env< V > ( variables: V , options?: { default?: ProcessEnv ; override?: ProcessEnv ; } ) : { [ v in "ADDRESS_DISCOVERY" | "ARRIVAL_PHASE_DURATION_IN_SECS" | "ASSET_PROVIDER" | "ASSET_PROVIDER_PARAMS" | "CHAIN_HISTORY_PROVIDER" | "CHAIN_HISTORY_PROVIDER_PARAMS" | "DB_SYNC_CONNECTION_STRING" | "HANDLE_PROVIDER" | "HANDLE_PROVIDER_PARAMS" | "KEY_MANAGEMENT_PARAMS" | "KEY_MANAGEMENT_PROVIDER" | "LOGGER_MIN_SEVERITY" | "NETWORK_INFO_PROVIDER" | "NETWORK_INFO_PROVIDER_PARAMS" | "OGMIOS_URL" | "REWARDS_PROVIDER" | "REWARDS_PROVIDER_PARAMS" | "STAKE_POOL_CONNECTION_STRING" | "STAKE_POOL_PROVIDER" | "STAKE_POOL_PROVIDER_PARAMS" | "STAKE_POOL_TEST_CONNECTION_STRING" | "START_LOCAL_HTTP_SERVER" | "TRANSACTIONS_NUMBER" | "TX_SUBMIT_HTTP_URL" | "TX_SUBMIT_PROVIDER" | "TX_SUBMIT_PROVIDER_PARAMS" | "UTXO_PROVIDER" | "UTXO_PROVIDER_PARAMS" | "VIRTUAL_USERS_COUNT" | "VIRTUAL_USERS_GENERATE_DURATION" | "WALLET_SYNC_TIMEOUT_IN_MS" | "WORKER_PARALLEL_TRANSACTION" ] : { ADDRESS_DISCOVERY: ValidatorSpec < string > ; ARRIVAL_PHASE_DURATION_IN_SECS: ValidatorSpec < number > ; ASSET_PROVIDER: ValidatorSpec < string > ; ASSET_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; CHAIN_HISTORY_PROVIDER: ValidatorSpec < string > ; CHAIN_HISTORY_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; DB_SYNC_CONNECTION_STRING: ValidatorSpec < string > ; HANDLE_PROVIDER: ValidatorSpec < string > ; HANDLE_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; KEY_MANAGEMENT_PARAMS: ValidatorSpec < KeyManagementParams > ; KEY_MANAGEMENT_PROVIDER: ValidatorSpec < string > ; LOGGER_MIN_SEVERITY: ValidatorSpec < string > ; NETWORK_INFO_PROVIDER: ValidatorSpec < string > ; NETWORK_INFO_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; OGMIOS_URL: ValidatorSpec < string > ; REWARDS_PROVIDER: ValidatorSpec < string > ; REWARDS_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; STAKE_POOL_CONNECTION_STRING: ValidatorSpec < string > ; STAKE_POOL_PROVIDER: ValidatorSpec < string > ; STAKE_POOL_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; STAKE_POOL_TEST_CONNECTION_STRING: ValidatorSpec < string > ; START_LOCAL_HTTP_SERVER: ValidatorSpec < boolean > ; TRANSACTIONS_NUMBER: ValidatorSpec < number > ; TX_SUBMIT_HTTP_URL: ValidatorSpec < string > ; TX_SUBMIT_PROVIDER: ValidatorSpec < string > ; TX_SUBMIT_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; UTXO_PROVIDER: ValidatorSpec < string > ; UTXO_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; VIRTUAL_USERS_COUNT: ValidatorSpec < number > ; VIRTUAL_USERS_GENERATE_DURATION: ValidatorSpec < number > ; WALLET_SYNC_TIMEOUT_IN_MS: ValidatorSpec < number > ; WORKER_PARALLEL_TRANSACTION: ValidatorSpec < number > ; } [ v ] extends ValidatorSpec < T > ? T : never }
Type Parameters
V extends readonly ( "ADDRESS_DISCOVERY" | "ARRIVAL_PHASE_DURATION_IN_SECS" | "ASSET_PROVIDER" | "ASSET_PROVIDER_PARAMS" | "CHAIN_HISTORY_PROVIDER" | "CHAIN_HISTORY_PROVIDER_PARAMS" | "DB_SYNC_CONNECTION_STRING" | "HANDLE_PROVIDER" | "HANDLE_PROVIDER_PARAMS" | "KEY_MANAGEMENT_PARAMS" | "KEY_MANAGEMENT_PROVIDER" | "LOGGER_MIN_SEVERITY" | "NETWORK_INFO_PROVIDER" | "NETWORK_INFO_PROVIDER_PARAMS" | "OGMIOS_URL" | "REWARDS_PROVIDER" | "REWARDS_PROVIDER_PARAMS" | "STAKE_POOL_CONNECTION_STRING" | "STAKE_POOL_PROVIDER" | "STAKE_POOL_PROVIDER_PARAMS" | "STAKE_POOL_TEST_CONNECTION_STRING" | "START_LOCAL_HTTP_SERVER" | "TRANSACTIONS_NUMBER" | "TX_SUBMIT_HTTP_URL" | "TX_SUBMIT_PROVIDER" | "TX_SUBMIT_PROVIDER_PARAMS" | "UTXO_PROVIDER" | "UTXO_PROVIDER_PARAMS" | "VIRTUAL_USERS_COUNT" | "VIRTUAL_USERS_GENERATE_DURATION" | "WALLET_SYNC_TIMEOUT_IN_MS" | "WORKER_PARALLEL_TRANSACTION" ) []
Parameters
variables: V
options: { default?: ProcessEnv ; override?: ProcessEnv ; } = {}
Optional
default?: ProcessEnv
Optional
override?: ProcessEnv
Returns { [ v in "ADDRESS_DISCOVERY" | "ARRIVAL_PHASE_DURATION_IN_SECS" | "ASSET_PROVIDER" | "ASSET_PROVIDER_PARAMS" | "CHAIN_HISTORY_PROVIDER" | "CHAIN_HISTORY_PROVIDER_PARAMS" | "DB_SYNC_CONNECTION_STRING" | "HANDLE_PROVIDER" | "HANDLE_PROVIDER_PARAMS" | "KEY_MANAGEMENT_PARAMS" | "KEY_MANAGEMENT_PROVIDER" | "LOGGER_MIN_SEVERITY" | "NETWORK_INFO_PROVIDER" | "NETWORK_INFO_PROVIDER_PARAMS" | "OGMIOS_URL" | "REWARDS_PROVIDER" | "REWARDS_PROVIDER_PARAMS" | "STAKE_POOL_CONNECTION_STRING" | "STAKE_POOL_PROVIDER" | "STAKE_POOL_PROVIDER_PARAMS" | "STAKE_POOL_TEST_CONNECTION_STRING" | "START_LOCAL_HTTP_SERVER" | "TRANSACTIONS_NUMBER" | "TX_SUBMIT_HTTP_URL" | "TX_SUBMIT_PROVIDER" | "TX_SUBMIT_PROVIDER_PARAMS" | "UTXO_PROVIDER" | "UTXO_PROVIDER_PARAMS" | "VIRTUAL_USERS_COUNT" | "VIRTUAL_USERS_GENERATE_DURATION" | "WALLET_SYNC_TIMEOUT_IN_MS" | "WORKER_PARALLEL_TRANSACTION" ] : { ADDRESS_DISCOVERY: ValidatorSpec < string > ; ARRIVAL_PHASE_DURATION_IN_SECS: ValidatorSpec < number > ; ASSET_PROVIDER: ValidatorSpec < string > ; ASSET_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; CHAIN_HISTORY_PROVIDER: ValidatorSpec < string > ; CHAIN_HISTORY_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; DB_SYNC_CONNECTION_STRING: ValidatorSpec < string > ; HANDLE_PROVIDER: ValidatorSpec < string > ; HANDLE_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; KEY_MANAGEMENT_PARAMS: ValidatorSpec < KeyManagementParams > ; KEY_MANAGEMENT_PROVIDER: ValidatorSpec < string > ; LOGGER_MIN_SEVERITY: ValidatorSpec < string > ; NETWORK_INFO_PROVIDER: ValidatorSpec < string > ; NETWORK_INFO_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; OGMIOS_URL: ValidatorSpec < string > ; REWARDS_PROVIDER: ValidatorSpec < string > ; REWARDS_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; STAKE_POOL_CONNECTION_STRING: ValidatorSpec < string > ; STAKE_POOL_PROVIDER: ValidatorSpec < string > ; STAKE_POOL_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; STAKE_POOL_TEST_CONNECTION_STRING: ValidatorSpec < string > ; START_LOCAL_HTTP_SERVER: ValidatorSpec < boolean > ; TRANSACTIONS_NUMBER: ValidatorSpec < number > ; TX_SUBMIT_HTTP_URL: ValidatorSpec < string > ; TX_SUBMIT_PROVIDER: ValidatorSpec < string > ; TX_SUBMIT_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; UTXO_PROVIDER: ValidatorSpec < string > ; UTXO_PROVIDER_PARAMS: ValidatorSpec < ProviderParams > ; VIRTUAL_USERS_COUNT: ValidatorSpec < number > ; VIRTUAL_USERS_GENERATE_DURATION: ValidatorSpec < number > ; WALLET_SYNC_TIMEOUT_IN_MS: ValidatorSpec < number > ; WORKER_PARALLEL_TRANSACTION: ValidatorSpec < number > ; } [ v ] extends ValidatorSpec < T > ? T : never }
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