@faasjs/load 1.4.2 → 1.5.0

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.
Files changed (2) hide show
  1. package/README.md +5 -52
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -1,64 +1,17 @@
1
1
  # @faasjs/load
2
2
 
3
- [![License: MIT](https://img.shields.io/npm/l/@faasjs/load.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/load/LICENSE)
4
- [![NPM Stable Version](https://img.shields.io/npm/v/@faasjs/load/stable.svg)](https://www.npmjs.com/package/@faasjs/load)
5
- [![NPM Beta Version](https://img.shields.io/npm/v/@faasjs/load/beta.svg)](https://www.npmjs.com/package/@faasjs/load)
6
-
7
3
  FaasJS's load module.
8
4
 
5
+ [![License: MIT](https://img.shields.io/npm/l/@faasjs/load.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/load/LICENSE)
6
+ [![NPM Version](https://img.shields.io/npm/v/@faasjs/load.svg)](https://www.npmjs.com/package/@faasjs/load)
7
+
9
8
  ## Install
10
9
 
11
10
  ```sh
12
11
  npm install @faasjs/load
13
12
  ```
14
13
 
15
- ## Modules
16
-
17
- ### Functions
18
-
19
- - [loadConfig](#loadconfig)
20
- - [loadTs](#loadts)
21
-
22
14
  ## Functions
23
15
 
24
- ### loadConfig
25
-
26
- ▸ **loadConfig**(`root`, `filename`): `Config`
27
-
28
- 加载配置
29
-
30
- #### Parameters
31
-
32
- | Name | Type | Description |
33
- | :------ | :------ | :------ |
34
- | `root` | `string` | {string} 根目录 |
35
- | `filename` | `string` | {filename} 目标文件,用于读取目录层级 |
36
-
37
- #### Returns
38
-
39
- `Config`
40
-
41
- ___
42
-
43
- ### loadTs
44
-
45
- ▸ **loadTs**(`filename`, `options?`): `Promise`\<\{ `dependencies`: \{ `[key: string]`: `string`; } ; `module?`: `Func` ; `modules?`: \{ `[key: string]`: `string`; } }\>
46
-
47
- 加载 ts 文件
48
-
49
- #### Parameters
50
-
51
- | Name | Type | Description |
52
- | :------ | :------ | :------ |
53
- | `filename` | `string` | {string} 完整源文件路径 |
54
- | `options` | `Object` | {object} 配置项 |
55
- | `options.input?` | `Object` | {object} 读取配置 |
56
- | `options.modules?` | `Object` | {object} 生成 modules 的配置 |
57
- | `options.modules.additions?` | `string`[] | - |
58
- | `options.modules.excludes?` | `string`[] | - |
59
- | `options.output?` | `Object` | {object} 写入配置 |
60
- | `options.tmp?` | `boolean` | {boolean} 是否为临时文件,true 则生成的文件会被删除,默认为 false |
61
-
62
- #### Returns
63
-
64
- `Promise`\<\{ `dependencies`: \{ `[key: string]`: `string`; } ; `module?`: `Func` ; `modules?`: \{ `[key: string]`: `string`; } }\>
16
+ - [loadConfig](functions/loadConfig.md)
17
+ - [loadTs](functions/loadTs.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faasjs/load",
3
- "version": "1.4.2",
3
+ "version": "1.5.0",
4
4
  "license": "MIT",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,15 +25,15 @@
25
25
  "rollup": "*"
26
26
  },
27
27
  "peerDependencies": {
28
- "@faasjs/deep_merge": "1.4.2",
29
- "@faasjs/func": "1.4.2",
30
- "@faasjs/ts-transform": "1.4.2"
28
+ "@faasjs/deep_merge": "1.5.0",
29
+ "@faasjs/func": "1.5.0",
30
+ "@faasjs/ts-transform": "1.5.0"
31
31
  },
32
32
  "devDependencies": {
33
33
  "@types/js-yaml": "*",
34
- "@faasjs/deep_merge": "1.4.2",
35
- "@faasjs/func": "1.4.2",
36
- "@faasjs/ts-transform": "1.4.2"
34
+ "@faasjs/deep_merge": "1.5.0",
35
+ "@faasjs/func": "1.5.0",
36
+ "@faasjs/ts-transform": "1.5.0"
37
37
  },
38
38
  "engines": {
39
39
  "npm": ">=9.0.0",