EnvironmentVariableModule

PackageAxial.PlatformService
Helpers for reading and parsing environment variables through an explicit service.

Summary

NameSignatureSynopsis
Operations
getEnvironmentVariable.get nameReads a raw string environment variable through an explicit service.
tryGetEnvironmentVariable.tryGet nameReads a raw string environment variable without wrapping it in a result.
getIntEnvironmentVariable.getInt nameReads an integer environment variable through an explicit service.
getInt64EnvironmentVariable.getInt64 nameReads a 64-bit integer environment variable through an explicit service.
getDoubleEnvironmentVariable.getDouble nameReads a floating-point environment variable through an explicit service.
getDecimalEnvironmentVariable.getDecimal nameReads a decimal environment variable through an explicit service.
getGuidEnvironmentVariable.getGuid nameReads a GUID environment variable through an explicit service.
getUriEnvironmentVariable.getUri nameReads a URI environment variable through an explicit service.
getTimeSpanEnvironmentVariable.getTimeSpan nameReads a time span environment variable through an explicit service.
getBoolEnvironmentVariable.getBool nameReads a boolean environment variable through an explicit service.

Operations

kind:member

get

EnvironmentVariable.get name
Member
Reads a raw string environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, string>
kind:member

tryGet

EnvironmentVariable.tryGet name
Member
Reads a raw string environment variable without wrapping it in a result.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, 'error, string option>
kind:member

getInt

EnvironmentVariable.getInt name
Member
Reads an integer environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, int>
kind:member

getInt64

EnvironmentVariable.getInt64 name
Member
Reads a 64-bit integer environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, int64>
kind:member

getDouble

EnvironmentVariable.getDouble name
Member
Reads a floating-point environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, float>
kind:member

getDecimal

EnvironmentVariable.getDecimal name
Member
Reads a decimal environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, decimal>
kind:member

getGuid

EnvironmentVariable.getGuid name
Member
Reads a GUID environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, Guid>
kind:member

getUri

EnvironmentVariable.getUri name
Member
Reads a URI environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, Uri>
kind:member

getTimeSpan

EnvironmentVariable.getTimeSpan name
Member
Reads a time span environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, TimeSpan>
kind:member

getBool

EnvironmentVariable.getBool name
Member
Reads a boolean environment variable through an explicit service.

Parameters

NameTypeDescription
namestring

Returns

Flow<'env, EnvironmentVariableError, bool>