@ttoss/read-config-file 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +674 -0
- package/README.md +28 -0
- package/dist/esm/index.js +2298 -0
- package/dist/index.d.cts +7 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +2300 -0
- package/package.json +51 -0
- package/src/index.ts +54 -0
- package/src/loadConfig.ts +46 -0
package/README.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# @ttoss/read-config-file
|
|
2
|
+
|
|
3
|
+
This package is a simple utility to read a configuration file in multiple formats:
|
|
4
|
+
|
|
5
|
+
- .json
|
|
6
|
+
- .yaml / .yml
|
|
7
|
+
- .js
|
|
8
|
+
- .ts
|
|
9
|
+
|
|
10
|
+
This package is ESM only.
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
pnpm add @ttoss/read-config-file
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
import { readConfigFile, readConfigFileSync } from '@ttoss/read-config-file';
|
|
22
|
+
|
|
23
|
+
const config1 = await readConfigFile({ configFilePath: 'path/to/config.json' });
|
|
24
|
+
|
|
25
|
+
const config2 = readConfigFileSync({
|
|
26
|
+
configFilePath: 'path/to/config.json',
|
|
27
|
+
});
|
|
28
|
+
```
|