UNPKG

@litert/config-loader

Version:

A configuration file loader for JavaScript application.

github.com/litert/config-loader.js

litert/config-loader.js

114 lines (58 loc) • 2.67 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
[Documents for @litert/config-loader](../../../index.md) / [Readers/LocalFileReader](../index.md) / LocalFileReader # Class: LocalFileReader Defined in: [src/lib/Readers/LocalFileReader.ts:46](https://github.com/litert/config-loader.js/blob/master/src/lib/Readers/LocalFileReader.ts#L46) The data reader for files in the local file system. ## Implements - [`IDataReader`](../../../Declaration/interfaces/IDataReader.md) ## Constructors ### Constructor > **new LocalFileReader**(`opts`): `LocalFileReader` Defined in: [src/lib/Readers/LocalFileReader.ts:52](https://github.com/litert/config-loader.js/blob/master/src/lib/Readers/LocalFileReader.ts#L52) #### Parameters ##### opts [`ILocalFileReaderOptions`](../interfaces/ILocalFileReaderOptions.md) #### Returns `LocalFileReader` ## Methods ### read() > **read**(`filePath`): `Promise`\<[`IReadResult`](../../../Declaration/interfaces/IReadResult.md)\> Defined in: [src/lib/Readers/LocalFileReader.ts:94](https://github.com/litert/config-loader.js/blob/master/src/lib/Readers/LocalFileReader.ts#L94) Read the content of the given path and return the result. #### Parameters ##### filePath `string` #### Returns `Promise`\<[`IReadResult`](../../../Declaration/interfaces/IReadResult.md)\> #### Implementation of [`IDataReader`](../../../Declaration/interfaces/IDataReader.md).[`read`](../../../Declaration/interfaces/IDataReader.md#read) *** ### readSync() > **readSync**(`filePath`): [`IReadResult`](../../../Declaration/interfaces/IReadResult.md) Defined in: [src/lib/Readers/LocalFileReader.ts:77](https://github.com/litert/config-loader.js/blob/master/src/lib/Readers/LocalFileReader.ts#L77) The synchronous version of `read()`. #### Parameters ##### filePath `string` #### Returns [`IReadResult`](../../../Declaration/interfaces/IReadResult.md) #### Implementation of [`IDataReader`](../../../Declaration/interfaces/IDataReader.md).[`readSync`](../../../Declaration/interfaces/IDataReader.md#readsync) *** ### resolvePath() > **resolvePath**(`ref`, `file`): `string` Defined in: [src/lib/Readers/LocalFileReader.ts:58](https://github.com/litert/config-loader.js/blob/master/src/lib/Readers/LocalFileReader.ts#L58) Resolve the path of `filePath` relative to `refFile`. #### Parameters ##### ref `string` ##### file `string` #### Returns `string` The absolute path of `filePath`. #### Example ```ts `resolveRelativePath('/path/to/file1.json', './a/file2.json')` returns `/path/to/a/file2.json`. ``` #### Implementation of [`IDataReader`](../../../Declaration/interfaces/IDataReader.md).[`resolvePath`](../../../Declaration/interfaces/IDataReader.md#resolvepath)