EnvironmentVariableModule
PackageAxial.PlatformService
Helpers for reading and parsing environment variables through an explicit service.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| get | EnvironmentVariable.get name | Reads a raw string environment variable through an explicit service. |
| tryGet | EnvironmentVariable.tryGet name | Reads a raw string environment variable without wrapping it in a result. |
| getInt | EnvironmentVariable.getInt name | Reads an integer environment variable through an explicit service. |
| getInt64 | EnvironmentVariable.getInt64 name | Reads a 64-bit integer environment variable through an explicit service. |
| getDouble | EnvironmentVariable.getDouble name | Reads a floating-point environment variable through an explicit service. |
| getDecimal | EnvironmentVariable.getDecimal name | Reads a decimal environment variable through an explicit service. |
| getGuid | EnvironmentVariable.getGuid name | Reads a GUID environment variable through an explicit service. |
| getUri | EnvironmentVariable.getUri name | Reads a URI environment variable through an explicit service. |
| getTimeSpan | EnvironmentVariable.getTimeSpan name | Reads a time span environment variable through an explicit service. |
| getBool | EnvironmentVariable.getBool name | Reads a boolean environment variable through an explicit service. |
Reads a raw string environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, string>
Reads a raw string environment variable without wrapping it in a result.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, 'error, string option>
Reads an integer environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, int>
Reads a 64-bit integer environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, int64>
Reads a floating-point environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, float>
Reads a decimal environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, decimal>
Reads a GUID environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, Guid>
Reads a URI environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, Uri>
Reads a time span environment variable through an explicit service.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string |
Returns
Flow<'env, EnvironmentVariableError, TimeSpan>