• Introduction
• Create a Config File
• Config File Anatomy
• Usage
• Env Files

Introduction

Config files are one of the back-bones of your application as they can be used to customize how you application behaves or interacts with other applications or services.

Config files are located in the config directory of your project.

Note

For every change ypu make to any config file, you need to run dartisan generate to re-generate the config map for your application, thereby making your changes visible to the application.

Create a Config File

To create a config file, use the command below:

dartisan make:config <config-name>

The above command creates config-name in the config folder.

Note

<config-name> is created as a file in {$lowercase}.dart and the class name in file is created in ucfirst case.

Config File Anatomy

A config class named payment.dart for instance will likely have the contents below

import 'package:daravel_core/annotations/config.dart';

@Config()
class Payment {
  String gateway = 'stripe';

  int tokenTTL = 1800;

  int minimumDeposit = 1000;

  // Other config fields
}

Note

Every config file has the @Config annotation at the top of the class. without it, the code generator will not be able to find the config file and generate it's map.

Usage

To get a config value, you can use the config() helper function like below to get the tokenTTL value in the example config file above:

int tokenTTL = config<int>('payment.tokenTTL');

You can also specify a default value of the config field as the second argument of the config function in case the config value isn't set.

Env Files

Daravel supports the use of .env files and can be used together with your configuration files, below is a slight modification to two examples above.

import 'package:daravel_core/annotations/config.dart';

@Config()
class Payment {
  String gateway = env<String>('PAYMENT_GATEWAY', 'stripe');

  int tokenTTL = env<int>('TOKEN_TTL');

  int minimumDeposit = env<int>('MINIMUM_DEPOSIT', 1000);

  // Other config fields
}