@ljobse/appsettings-loader/README.md

This allows you to automatically map environment variables typed into your application.

# Appsettings json config loader

## A simple tool to load config data

This allows you to automatically map environment variables typed into your application.

- By overwriting the saved file during the build (CLI, intended for Frontend applications)
- By setting the values at runtime (import, intended for Backend applications)

## Install

```bash
# with npm
npm install @ljobse/appsettings-loader

# or with Yarn
yarn add @ljobse/appsettings-loader
```

# CLI

The CLI allows you to overwrite properties in the json file from the current process.env context.

```bash
$ appsettings-loader ./config/appsettings.json
```

# Lib

The library allows you to load the current process.env variables into an imported js(on) object.

```javascript
var newSettings = applyEnvConfig(require("./config/appsettings.json"));
```

- Nesting is supported by dot separation `.` and double underscores `__`.
- Types are inherited
- Case insensitive
- Omits underscores `_`

### Real world example

Environment on cloud provider or locally is set with the variables you need to load into your application.

```dosini
#process.env

DATABASE_NAME=server_db
```

```json
//# src/config/config.json
{
  "databaseName": "postgres"
}
```

```typescript
//# src/config/index.ts

import { applyEnvConfig } from "@ljobse/appsettings-loader";
import appsettings from "./config.json";

const config = applyEnvConfig(appsettings);

export { config };
```

```typescript
//# src/app.ts

import { config } from "./config";

console.log(config.databaseName);
// => "server_db"
```

### Array support

JSON arrays are supported in the values as well.

In your config you can define the structure of the array.

```json
{
  "app": { "arr": [{ "foo": "bar" }] }
}
```

The env variable should look like this to override:

```
APP__ARR=[{"foo":"baz"}]
```

and then the result will be:

```typescript
//# src/app.ts

import { config } from "./config";

console.log(config.app.arr);
// => [{ foo: "baz" }]
```