Configuration

Under the hood, we are using neko-config library to help with managing configuration.

To start place your related configs in config/default.ts file and it will be autoloaded.

import { config } from "@devbro/pashmak/config";

console.log(config.get("databases"));

it may become needed to load some values from envvars. to do this, use this approach:

// config/default.ts
export default {
  port: process.env.PORT || 3000,
};

More configurations

There can be multiple features that depends on configurations to run successfully such as database, file, caching, and etc. To make maintaining configurations for each of these features, it is strongly suggested to keep their configurations in separate files and import(await import()) them into default config. the main configuration for each of these services must be named default. for example, if your system is connecting to 3 different databases, the main database must be labelled default, the second and third, can be given any name of your own choosing.

custom feature configurations

If you decide to create your own custom feature, for example a payment processing, that needs configuration, you can create your own XYZ.ts file similar to:

// payment.ts
export default {
  provider: 'stripe',
  ....
}

//optional if you are planning to connect to more than one service
export const secondary_payment_system = {
  ?????
}

//default.ts
export default {
  ?????
  payment_system: require('./payment');
};

// somewhere else in your code
import config from '@devbro/pashmak/config';


if(config.get('payment_system.default.provider') === 'stripe') {
  // standard payment processing
}
else if(config.get('payment_system.secondary_payment_system') === 'bitcoin') {
 // backup payment processing
}

.env AKA dotenv

there is also .env support in case you want to load some configs that way. please note, you will still need to add the specific configs you want to default.js to be able to access the values.

Force config to exists

some configs are essential and you want to stop the process without them. If these values need to come from envar, you can do this:

import { getEnv } from "@devbro/pashmak/helper";

export default {
  https_port: getEnv("HTTPS_PORT", 443),
  port: getEnv("PORT"),
  ssh_port: getEnv("SSH_PORT", undefined),
};

if PORT is not defined, an error is thrown and stopping the process entirely before it starts.

if HTTPS_PORT is not defined, it will use default value of 443 and will not throw an error.

if ssh_port is not defined, it will use default value of undefined and will NOT throw an error.