@faasjs/load 0.0.2-beta.359 → 0.0.2-beta.363

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