# simcfg

> A simple module for managing configuration files

Latest version **1.0.4** (published 2021-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install simcfg
pnpm add simcfg
yarn add simcfg
bun add simcfg
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2021-11-22 |
| First published | 2021-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | 80LK |
| Maintainers | 80lk |
| Keywords | config, json, yaml |

## Links

- npm: https://www.npmjs.com/package/simcfg
- Repository: https://github.com/80LK/simcfg
- Homepage: https://github.com/80LK/simcfg#readme
- Issues: https://github.com/80LK/simcfg/issues
- npm.io page: https://npm.io/package/simcfg

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.4 (latest) — 2021-11-22
- 1.0.3 — 2021-11-21
- 1.0.2 — 2021-11-21
- 1.0.1 — 2021-11-21
- 1.0.0 — 2021-11-20

## README

# Simple Config(simcfg)
A simple module for managing configuration files

[**en**|[ru](README.RU.md)]

## Install

```
npm i --save simcfg
```

You can install the [yaml](https://www.npmjs.com/package/yaml) module, if you want to use [YAML](https://en.wikipedia.org/wiki/YAML) format files.
```
npm i --save yaml
```

## Usage

### New config
```ts
const config = new Config();//Empty config
const config = new Config({
	a:1
});// Config with a = 1
```

### Reading the file.
```ts
const config:Config = await Config.parseFromFile("test.json"); // Promise
const config:Config = Config.parseFromFileSync("test.json");

config.parseFromFile("test.json"); // Promise
config.parseFromFileSync("test.json"); 
```

**!!!WARNING!!!**
The next entry in the config will throw an error when reading the file, due to an attempt to overwrite the value of *a*.
```json
{
	"a":1,
	"a.b":2
}
```
```yml
a: 1
a.b: 2
```

### Getting values
If no value is found and no standard value is specified. the method will throw an error.
```ts
/*
@config
{
	"a":1,
	"c":{
		"e":false
	}
}
*/
config.get<number>("a"); // return 1
config.get<number>("b", 10); // return 10
config.get<string>("c.d", "defaultValue"); //return "defaultValue"
config.get<boolean>("c.e", false);//return false
config.get<number>("f");// throw Error
```

#### !!!WARNING!!!
With the following config entry:
```json
{
	"a": 1,
	"a.b": 2
}
```
```yml
a: 1
a.b: 2
```
it is impossible to get the *b* field from *a* as from an object.
```ts
config.get("a.b"); //return 2
config.get("a"); //return 1
config.get("a").b // 1.b === undefined
```

### Changing values
If the config is immutable, the method will throw an error.
```ts
const config = Config.parseFromFileSync("...");
config.set("a", 10); //Success

const config = Config.parseFromFileSync("...", true);
config.set("a", 10); //throw Error
```

### Writing to a file
If the file is not specified, the config will be written to the file from which it was read.
```ts
const config = Config.parseFromFileSync("test.json");
config.set("a", 1);

config.writeFile("new-test.json");// The config is written to a new file "new-test.json"
config.WriteFile();// Config is written to the old file "test.json"
```

The file can also be written in another format
```js
const config = Config.parseFromFileSync("test.json");
config.writeFile("new-test.yaml");// The config is written in YAML format
``

---
_Source: https://npm.io/package/simcfg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._