ENVied

https://pub.dev/documentation/envied/latest/
Admin
ENVied is a Dart/Flutter package that provides a cleaner way to handle environment variables by...
Tokens:6,593
Snippets:88
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example .env file with multiple variables

Source: https://pub.dev/documentation/envied/latest/index.html

An example .env file demonstrating multiple key-value pairs.

```dotenv
KEY1=VALUE1
KEY2=VALUE2

```

--------------------------------

### Define .env file

Source: https://pub.dev/documentation/envied/latest/index.html

Example of a simple .env file format.

```dotenv
KEY=VALUE

```

--------------------------------

### Define environment variable files

Source: https://pub.dev/documentation/envied/latest/index.html

Example content for .env files used with system environment variable mapping.

```text
API_KEY=LATEST_API_KEY
```

```text
API_KEY=STAGE_API_KEY
```

--------------------------------

### Define System Environment Variable

Source: https://pub.dev/documentation/envied/latest/index.html

Example of setting an environment variable using the export command in a shell.

```bash
export VAR=test

```

--------------------------------

### Install ENVied and Generator

Source: https://pub.dev/documentation/envied/latest/index.html

Command to add envied and envied_generator as development dependencies.

```bash
dart pub add envied dev:envied_generator dev:build_runner

```

--------------------------------

### Obfuscation with static final

Source: https://pub.dev/documentation/envied/latest/index.html

Example showing that obfuscation requires the field to be static final, not static const.

```dart
abstract class Env {
  @EnviedField(obfuscate: true)
  static final String apiKey = _Env.apiKey;
}

```

--------------------------------

### Envied Annotation Name Property Example

Source: https://pub.dev/documentation/envied/latest/envied/Envied/name.html

Specifies a custom name for the generated class using the 'name' property. If null or empty, the annotated class name is used.

```dart
final String? name;
```

```dart
@Envied(name: 'Foo')
abstract class Env {}

```

```dart
abstract class _Foo {}

```

--------------------------------

### Clean and rebuild the project

Source: https://pub.dev/documentation/envied/latest/index.html

Run these commands to clear the build cache and force the generator to pick up changes in .env files.

```bash
dart run build_runner clean
dart run build_runner build --delete-conflicting-outputs
```

--------------------------------

### Run Build Runner

Source: https://pub.dev/documentation/envied/latest/index.html

Command to execute the build_runner to generate the env.g.dart file.

```bash
dart run build_runner build

```

--------------------------------

### Set environment file via CLI

Source: https://pub.dev/documentation/envied/latest/index.html

Use the --define flag to specify the .env file path during the build process.

```bash
dart run build_runner build --define=envied_generator:envied=path=my_other.env
```

--------------------------------

### path property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/path.html

Defines the file path of the .env file relative to the project root.

```APIDOC
## path property

### Description
The file path of the `.env` file, relative to the project root, which will be used to generate environment variables. If `null` or an empty String, `.env` is used.

### Implementation
```dart
final String path;
```
```

--------------------------------

### Optional Property Implementation

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/optional.html

Demonstrates how to declare and use an optional boolean property.

```APIDOC
## Optional Property

### Description
This section details the implementation of an optional boolean property named `optional`. This property is designed to be nullable and can be omitted during instantiation without causing an error, provided a default value is not strictly required.

### Method
Declaration

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## Implementation Details

- **`optional`** (bool?) - Optional - Allows this field to be optional when the type is nullable. With this enabled, the generator will not throw an exception if the environment variable is missing and a default value was not set.

### Code Example
```dart
final bool? optional;
```
```

--------------------------------

### Environment Property Configuration

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/environment.html

Details regarding the environment property and its behavior in the application.

```APIDOC
## Property: environment

### Description
A boolean property that dictates how environment variables are resolved. When set to true, the value in the .env file acts as a key to look up the actual value from Platform.environment.

### Type
bool?

### Implementation
```dart
final bool? environment;
```
```

--------------------------------

### Envied Constructor Implementation

Source: https://pub.dev/documentation/envied/latest/envied/Envied/Envied.html

The constructor initializes the environment configuration with default values for file paths and requirement flags.

```dart
const Envied({
  String? path,
  bool? requireEnvFile,
  this.name,
  this.obfuscate = false,
  this.allowOptionalFields = false,
  this.environment = false,
  this.useConstantCase = false,
  this.interpolate = true,
  this.rawStrings = false,
  this.randomSeed,
}) : path = path ?? '.env',
     requireEnvFile = requireEnvFile ?? false;
```

--------------------------------

### Use system environment variables

Source: https://pub.dev/documentation/envied/latest/index.html

Instruct the generator to treat .env values as keys for system environment variables.

```dart
@Envied(environment: true)
final class Env {
  @EnviedField(varName: 'API_KEY')
  static const  String apiKey = _Env.apiKey;
}
```

```dart
@Envied()
final class Env {
  @EnviedField(environment: true, varName: 'API_KEY')
  static const  String apiKey = _Env.apiKey;
}
```

--------------------------------

### Enable override in build.yaml

Source: https://pub.dev/documentation/envied/latest/index.html

Ensure the override parameter is set to true in build.yaml to allow CLI path changes.

```yaml
targets:
  $default:
    builders:
      envied_generator|envied:
        options:
          override: true
```

--------------------------------

### Override build configuration

Source: https://pub.dev/documentation/envied/latest/index.html

Specify a custom .env file path in build.yaml to override default settings.

```yaml
targets:
  $default:
    builders:
      envied_generator|envied:
        options:
          path: .env.custom
          override: true
```

--------------------------------

### Generated environment classes

Source: https://pub.dev/documentation/envied/latest/index.html

The resulting generated code implements the environment classes based on the provided .env files.

```dart
part of 'multi_env.dart';

final class _ProductionEnv implements MultiEnv {
  @override
  final String key1 = 'foo';

  @override
  final String key2 = 'bar';
}

final class _DebugEnv implements MultiEnv {
  @override
  final String key1 = 'debug_foo';

  @override
  final String key2 = 'debug_bar';
}
```

--------------------------------

### Environment Property Configuration

Source: https://pub.dev/documentation/envied/latest/envied/Envied/environment.html

Details regarding the boolean environment property and its behavior in the application.

```APIDOC
## Property: environment

### Description
Determines whether to read the ultimate values from Platform.environment rather than from the .env file. When set to true, the value found in the .env file is used as the key, and the ultimate value is retrieved from Platform.environment.

### Type
bool

### Implementation
final bool environment;
```

--------------------------------

### requireEnvFile Configuration

Source: https://pub.dev/documentation/envied/latest/envied/Envied/requireEnvFile.html

Details regarding the requireEnvFile boolean property and its impact on the build_runner process.

```APIDOC
## Property: requireEnvFile

### Description
Determines whether the build_runner should enforce the existence of an environment file. If set to true, the build process will fail if the specified file does not exist.

### Type
bool

### Implementation
final bool requireEnvFile;
```

--------------------------------

### EnviedField Constructor

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/EnviedField.html

Defines the configuration parameters for an EnviedField instance.

```APIDOC
## EnviedField Constructor

### Description
Creates a new instance of EnviedField to configure how environment variables are processed.

### Parameters
- **varName** (String?) - Optional - The name of the variable.
- **obfuscate** (bool?) - Optional - Whether to obfuscate the value.
- **defaultValue** (Object?) - Optional - The default value if the variable is missing.
- **environment** (bool?) - Optional - Whether to pull from environment variables.
- **optional** (bool?) - Optional - Whether the field is optional.
- **useConstantCase** (bool?) - Optional - Whether to enforce constant case naming.
- **interpolate** (bool?) - Optional - Whether to enable string interpolation.
- **rawString** (bool?) - Optional - Whether to treat the value as a raw string.
- **randomSeed** (int?) - Optional - A seed for random generation.
```

--------------------------------

### EnviedField Constructor Implementation

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/EnviedField.html

The actual implementation of the EnviedField constructor, assigning the provided parameters to their respective fields. This code initializes an EnviedField object.

```dart
const EnviedField({
  this.varName,
  this.obfuscate,
  this.defaultValue,
  this.environment,
  this.optional,
  this.useConstantCase,
  this.interpolate,
  this.rawString,
  this.randomSeed,
});
```

--------------------------------

### Implement Obfuscate Property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/obfuscate.html

This snippet shows the implementation of the `obfuscate` property, which must be declared as `final`. It allows for runtime encryption of values.

```dart
final bool? obfuscate;
```

--------------------------------

### Declare requireEnvFile Property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/requireEnvFile.html

This property is a boolean that dictates whether an environment file is mandatory for the build process. If the file is absent and this is true, the build_runner will fail.

```dart
final bool requireEnvFile;
```

--------------------------------

### Initialize Envied constant

Source: https://pub.dev/documentation/envied/latest/envied/envied-constant.html

Instantiate the Envied class to configure environment variable loading.

```dart
const envied = Envied();
```

--------------------------------

### Accessing Environment Variables after Generation

Source: https://pub.dev/documentation/envied/latest/index.html

Demonstrates how to access the environment variables defined in the Env class after the build_runner has generated the part file.

```dart
print(Env.key1); // "VALUE1"
print(Env.KEY2); // "VALUE2"

```

--------------------------------

### varName Property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/varName.html

Details about the 'varName' property, including its type and function.

```APIDOC
## varName Property

### Description
Represents the environment variable name specified in the `.env` file to generate for the annotated variable.

### Type
String?

### Implementation
```dart
final String? varName;
```
```

--------------------------------

### Raw String Property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/rawString.html

Details about the rawString boolean property and its behavior.

```APIDOC
## Raw String Property

### Description
Controls whether the string value should be formatted as a raw string. This property can only be used with string types. When set to true, it creates a raw string literal (e.g., `r'<value>'`), which may not contain a single quote. It also escapes single quotes and newlines within the value.

### Property
- **rawString** (bool?) - Optional - Whether to use the raw string format for the value.

### Note
The string is always formatted as `'<value>'` by default. If `rawString` is `true`, the string is formatted as `r'<value>'` and special characters like single quotes and newlines are escaped.

### Implementation
```dart
final bool? rawString;
```
```

--------------------------------

### Declare String Path Property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/path.html

Declares a final String variable named 'path' to store the file path.

```dart
final String path;
```

--------------------------------

### Envied Constructor

Source: https://pub.dev/documentation/envied/latest/envied/Envied/Envied.html

The Envied constructor allows you to customize the behavior of environment variable loading, such as specifying the path to the .env file, obfuscation, and more.

```APIDOC
## Envied Constructor

### Description
Initializes the Envied configuration with various options to control how environment variables are loaded.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **path** (String?) - Optional - Specifies the path to the .env file. Defaults to '.env'.
- **requireEnvFile** (bool?) - Optional - If true, an error will be thrown if the .env file is not found. Defaults to false.
- **name** (String?) - Optional - A name for the environment configuration.
- **obfuscate** (bool) - Optional - If true, sensitive environment variables will be obfuscated. Defaults to false.
- **allowOptionalFields** (bool) - Optional - If true, fields that are not present in the environment will be allowed. Defaults to false.
- **environment** (bool) - Optional - If true, indicates that this is for a specific environment (e.g., production, development). Defaults to false.
- **useConstantCase** (bool) - Optional - If true, environment variables will be expected in constant case (e.g., MY_VARIABLE). Defaults to false.
- **interpolate** (bool) - Optional - If true, allows for variable interpolation within .env file values. Defaults to true.
- **rawStrings** (bool) - Optional - If true, reads environment variables as raw strings, preventing type conversion. Defaults to false.
- **randomSeed** (int?) - Optional - A seed for random number generation, useful for reproducible tests.

### Request Example
```dart
const envied = Envied(
  path: '.env.development',
  obfuscate: true,
);
```

### Response
#### Success Response (200)
N/A (This is a constructor)

#### Response Example
N/A
```

--------------------------------

### Interpolate Property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/interpolate.html

Details the 'interpolate' property, its purpose, and its implementation.

```APIDOC
## Interpolate Property

### Description
Controls whether to use the interpolated value for the field. If interpolate is `true`, the value will be interpolated with the environment variables.

### Implementation
```dart
final bool? interpolate;
```
```

--------------------------------

### obfuscate property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/obfuscate.html

Details regarding the implementation and usage of the obfuscate property.

```APIDOC
## Property: obfuscate

### Description
Allows values to be encrypted using a randomly generated key that is XOR'd with the encrypted value upon first access. This property overrides the per-class obfuscate option.

### Requirements
- Must be declared as `final`.
- Cannot be used with the `const` qualifier.

### Implementation
```dart
final bool? obfuscate;
```
```

--------------------------------

### Configure constant case naming in Envied

Source: https://pub.dev/documentation/envied/latest/index.html

Enable automatic transformation of field names to CONSTANT_CASE for environment variable lookups.

```dart
@Envied(path: '.env', useConstantCase: true)
final class Env {
  @EnviedField()
  static const String apiKey = _Env.apiKey; // Transformed to 'API_KEY'

  @EnviedField(varName: 'apiKey')
  static const String apiKey = _Env.apiKey; // Searches for a variable named 'apiKey' inside the .env file and assigns it to apiKey
}
```

```dart
@EnviedField(useConstantCase: true)
static const String apiKey; // Transformed to 'API_KEY'

@EnviedField()
static const String apiKey; // Retains its original value, which is `apiKey`

@EnviedField(varName: 'DEBUG_API_KEY')
static const String apiKey; // Searches for a variable named 'DEBUG_API_KEY' inside the .env file and assigns it to apiKey
```

--------------------------------

### allowOptionalFields Property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/allowOptionalFields.html

Details regarding the allowOptionalFields boolean property and its impact on environment variable generation.

```APIDOC
## allowOptionalFields Property

### Description
A boolean property that allows all values to be optional when the type is nullable. When enabled, the generator will not throw an exception if an environment variable is missing and no default value is provided.

### Implementation
```dart
final bool allowOptionalFields;
```
```

--------------------------------

### name property configuration

Source: https://pub.dev/documentation/envied/latest/envied/Envied/name.html

Defines the name property used to customize the generated class name in the Envied library.

```APIDOC
## name property

### Description
The `name` property specifies the value to use as the name for the generated class, with an underscore `_` prefixed. If the value is `null` or an empty string, the name of the annotated class is used instead.

### Implementation
`final String? name;`

### Usage Example
```dart
@Envied(name: 'Foo')
abstract class Env {}
```

### Generated Output
```dart
abstract class _Foo {}
```
```

--------------------------------

### Accessing Environment Variable

Source: https://pub.dev/documentation/envied/latest/index.html

How to access the defined environment variable from the Env class.

```dart
print(Env.key); // "VALUE"

```

--------------------------------

### EnviedField Constructor Signature

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/EnviedField.html

Defines the parameters available for creating an EnviedField instance. These parameters control various aspects of how environment variables are read and processed.

```dart
const EnviedField({
  1. String? varName,
  2. bool? obfuscate,
  3. Object? defaultValue,
  4. bool? environment,
  5. bool? useConstantCase,
  6. bool? interpolate,
  7. bool? rawString,
  8. int? randomSeed,

})
```

--------------------------------

### Define useConstantCase property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/useConstantCase.html

The implementation definition for the useConstantCase boolean property.

```dart
final bool useConstantCase;
```

--------------------------------

### Define environment property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/environment.html

Declaration of the environment boolean property.

```dart
final bool environment;
```

--------------------------------

### Define environment property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/environment.html

Declaration of the environment property used to toggle lookup behavior.

```dart
final bool? environment;
```

--------------------------------

### EnviedField Constructor

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField-class.html

Details for the EnviedField annotation constructor used to configure environment variable generation.

```APIDOC
## EnviedField Constructor

### Description
Annotation used to specify an environment variable that should be generated from the .env file.

### Parameters
#### Constructor Parameters
- **varName** (String?) - Optional - The environment variable name specified in the .env file.
- **obfuscate** (bool?) - Optional - Whether to encrypt the value using XOR obfuscation.
- **defaultValue** (Object?) - Optional - Value to use if the environment variable is not set.
- **environment** (bool?) - Optional - If true, uses the .env value as a key to look up in Platform.environment.
- **optional** (bool?) - Optional - Allows the field to be optional if the type is nullable.
- **useConstantCase** (bool?) - Optional - Whether to convert the field name to CONSTANT_CASE.
- **interpolate** (bool?) - Optional - Whether to interpolate the value with other environment variables.
- **rawString** (bool?) - Optional - Whether to use raw string format.
- **randomSeed** (int?) - Optional - Seed for reproducible obfuscation.
```

--------------------------------

### Define multiple environments with Envied

Source: https://pub.dev/documentation/envied/latest/index.html

Use the @Envied annotation with path and name parameters to map different .env files to specific generated classes.

```dart
import 'package:envied/envied.dart';

part 'multi_env.g.dart';

@Envied(path: '.env', name: 'ProductionEnv')
@Envied(path: '.env_debug', name: 'DebugEnv')
final class MultiEnv {
  static const bool kDebugMode = true;

  factory MultiEnv() => _instance;

  static final MultiEnv _instance = switch (kDebugMode) {
    true => _DebugEnv(),
    false => _ProductionEnv(),
  };

  @EnviedField(varName: 'KEY1')
  final String key1 = _instance.key1;

  @EnviedField(varName: 'KEY2')
  final String key2 = _instance.key2;
}
```

--------------------------------

### Using useConstantCase in Envied

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/useConstantCase.html

Set useConstantCase to true to automatically convert field names to CONSTANT_CASE. This follows Dart conventions for constant names.

```dart
@EnvField(useConstantCase: true)
String apiKey;

```

--------------------------------

### Declare allowOptionalFields Property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/allowOptionalFields.html

This property is declared as a final boolean. It allows the generator to skip missing environment variables for nullable types without error.

```dart
final bool allowOptionalFields;
```

--------------------------------

### EnviedField Annotation

Source: https://pub.dev/documentation/envied/latest/envied

Annotation used to specify an individual environment variable to be generated from the .env file.

```APIDOC
## EnviedField Annotation

### Description
Annotation used to specify an environment variable that should be generated from the .env file specified in the Envied path parameter.
```

--------------------------------

### Envied Constructor

Source: https://pub.dev/documentation/envied/latest/envied/Envied-class.html

Configuration options for the Envied annotation used to specify how environment variables are processed and generated.

```APIDOC
## Envied Constructor

### Description
Annotation used to specify the class to contain environment variables that will be generated from a .env file.

### Parameters
- **path** (String?) - Optional - The file path of the .env file, relative to the project root.
- **requireEnvFile** (bool) - Optional - Whether to require an env file exists, or else the build_runner will fail.
- **name** (String?) - Optional - The value to use as name for the generated class, with an underscore prefixed.
- **obfuscate** (bool) - Optional - Allows all values to be encrypted using a random generated key.
- **allowOptionalFields** (bool) - Optional - Allows all values to be optional when the type is nullable.
- **environment** (bool) - Optional - Whether to read the ultimate values from Platform.environment rather than from the .env file.
- **useConstantCase** (bool) - Optional - Whether to convert field names from camelCase to CONSTANT_CASE.
- **interpolate** (bool) - Optional - Whether to interpolate the values for all fields.
- **rawStrings** (bool) - Optional - Whether to use the raw string format for all string values.
- **randomSeed** (int?) - Optional - A seed provided if the obfuscation randomness needs to remain reproducible across builds.
```

--------------------------------

### Declare VarName Property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/varName.html

This snippet shows the declaration of the nullable String varName property. It is used to specify the environment variable name in a .env file for an annotated variable.

```dart
final String? varName;
```

--------------------------------

### Dart Class for Environment Variables

Source: https://pub.dev/documentation/envied/latest/index.html

A Dart abstract class annotated with @envied to define environment variables and their mapping from .env files or system variables.

```dart
import 'package:envied/envied.dart';

part 'env.g.dart';

@envied
abstract class Env {
    @EnviedField(varName: 'KEY')
    static const String key = _Env.key;
}

```

--------------------------------

### Envied useConstantCase Property Declaration

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/useConstantCase.html

This shows the declaration of the useConstantCase property within the Envied implementation.

```dart
final bool? useConstantCase;

```

--------------------------------

### Allow Optional Fields

Source: https://pub.dev/documentation/envied/latest/index.html

Enabling optional fields at the class level using allowOptionalFields: true in the @Envied annotation.

```dart
@Envied(allowOptionalFields: true)
abstract class Env {
  @EnviedField()
  static const String? optionalServiceApiKey = _Env.optionalServiceApiKey;
}

```

--------------------------------

### Optional Field per Field

Source: https://pub.dev/documentation/envied/latest/index.html

Enabling optional fields on a per-field basis using the optional: true flag in the @EnviedField annotation.

```dart
@EnviedField(optional: true)

```

--------------------------------

### Define rawStrings property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/rawStrings.html

Declaration of the rawStrings boolean property.

```dart
final bool rawStrings;
```

--------------------------------

### Configure useConstantCase in Envied

Source: https://pub.dev/documentation/envied/latest/envied/Envied/useConstantCase.html

Set useUpperSnakeCase to true in the @Envied annotation to enable automatic transformation of field names to CONSTANT_CASE.

```dart
@Envied(useUpperSnakeCase: true)
class MyEnvironment {
  @EnvField()
  String apiKey; // Transformed to 'API_KEY'

  @EnvField(varName: 'MY_TOKEN')
  String token; // Specified varName retains original format
}
```

--------------------------------

### Declare Raw String Property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/rawString.html

This snippet shows the declaration of the rawString property, which is a nullable boolean. It can only be used with String types.

```dart
final bool? rawString;
```

--------------------------------

### Define randomSeed property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/randomSeed.html

Declaration of the randomSeed property used to control obfuscation randomness.

```dart
final int? randomSeed;
```

--------------------------------

### Envied Annotation

Source: https://pub.dev/documentation/envied/latest/envied

Annotation used to specify the class that will contain environment variables generated from a .env file.

```APIDOC
## Envied Annotation

### Description
Annotation used to specify the class to contain environment variables that will be generated from a .env file.

### Usage
Apply this annotation to a class to enable environment variable generation.
```

--------------------------------

### Declare Interpolate Property

Source: https://pub.dev/documentation/envied/latest/envied/Envied/interpolate.html

This snippet shows the declaration of the `interpolate` boolean property. Set to `true` to enable interpolation with environment variables.

```dart
final bool interpolate;
```

--------------------------------

### Obfuscation Flag

Source: https://pub.dev/documentation/envied/latest/index.html

Using the obfuscate flag within @EnviedField to obfuscate the environment variable's value.

```dart
@EnviedField(obfuscate: true)

```

--------------------------------

### Envied Class Configuration

Source: https://pub.dev/documentation/envied/latest/index.html

Dart class definition using @Envied with a custom path and @EnviedField for specific variables, including default values.

```dart
// lib/env/env.dart
import 'package:envied/envied.dart';

part 'env.g.dart';

@Envied(path: '.env.dev')
abstract class Env {
    @EnviedField(varName: 'KEY1')
    static const String key1 = _Env.key1;
    
    @EnviedField()
    static const String KEY2 = _Env.KEY2;
    
    @EnviedField(defaultValue: 'test_')
    static const String key3 = _Env.key3;
}

```

--------------------------------

### Define interpolate property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/interpolate.html

Declaration of the nullable boolean interpolate property.

```dart
final bool? interpolate;
```

--------------------------------

### Declare Optional Property in Dart

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/optional.html

Use 'final bool? optional;' to allow a field to be optional. This prevents generator exceptions if an environment variable is missing and no default value is set.

```dart
final bool? optional;
```

--------------------------------

### Declare defaultValue Property

Source: https://pub.dev/documentation/envied/latest/envied/EnviedField/defaultValue.html

This snippet shows the declaration of the defaultValue property, which is of type Object? and marked as final.

```dart
final Object? defaultValue;
```

--------------------------------

### Obfuscate Property Declaration

Source: https://pub.dev/documentation/envied/latest/envied/Envied/obfuscate.html

Declare the obfuscate property as final. This allows values to be encrypted upon first access. This setting can be overridden at the field level.

```dart
final bool obfuscate;
```
Tokens:
Raw