koatty 3.5.12-0 → 3.5.12

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 (79) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/index.d.ts +8 -3
  3. package/dist/index.js +2 -2
  4. package/dist/index.mjs +2 -2
  5. package/dist/package.json +8 -9
  6. package/package.json +8 -9
  7. package/.commitlintrc.js +0 -3
  8. package/.eslintignore +0 -11
  9. package/.eslintrc.js +0 -43
  10. package/.huskyrc +0 -5
  11. package/.versionrc.js +0 -16
  12. package/api-extractor.json +0 -345
  13. package/docs/api/index.md +0 -12
  14. package/docs/api/koatty.apiinput.code.md +0 -11
  15. package/docs/api/koatty.apiinput.data.md +0 -11
  16. package/docs/api/koatty.apiinput.md +0 -22
  17. package/docs/api/koatty.apiinput.message.md +0 -11
  18. package/docs/api/koatty.apioutput.code.md +0 -11
  19. package/docs/api/koatty.apioutput.data.md +0 -11
  20. package/docs/api/koatty.apioutput.md +0 -22
  21. package/docs/api/koatty.apioutput.message.md +0 -11
  22. package/docs/api/koatty.appreadyhookfunc.md +0 -11
  23. package/docs/api/koatty.basecontroller._constructor_.md +0 -20
  24. package/docs/api/koatty.basecontroller._options.md +0 -11
  25. package/docs/api/koatty.basecontroller.app.md +0 -11
  26. package/docs/api/koatty.basecontroller.ctx.md +0 -11
  27. package/docs/api/koatty.basecontroller.fail.md +0 -28
  28. package/docs/api/koatty.basecontroller.init.md +0 -19
  29. package/docs/api/koatty.basecontroller.md +0 -39
  30. package/docs/api/koatty.basecontroller.ok.md +0 -28
  31. package/docs/api/koatty.baseservice._constructor_.md +0 -20
  32. package/docs/api/koatty.baseservice._options.md +0 -11
  33. package/docs/api/koatty.baseservice.app.md +0 -11
  34. package/docs/api/koatty.baseservice.init.md +0 -25
  35. package/docs/api/koatty.baseservice.md +0 -36
  36. package/docs/api/koatty.bindappreadyhook.md +0 -26
  37. package/docs/api/koatty.bootstrap.md +0 -27
  38. package/docs/api/koatty.component.md +0 -27
  39. package/docs/api/koatty.componentscan.md +0 -27
  40. package/docs/api/koatty.configurationscan.md +0 -27
  41. package/docs/api/koatty.controller.md +0 -27
  42. package/docs/api/koatty.httpcontroller.body.md +0 -28
  43. package/docs/api/koatty.httpcontroller.deny.md +0 -26
  44. package/docs/api/koatty.httpcontroller.expires.md +0 -26
  45. package/docs/api/koatty.httpcontroller.fail.md +0 -28
  46. package/docs/api/koatty.httpcontroller.header.md +0 -27
  47. package/docs/api/koatty.httpcontroller.isget.md +0 -19
  48. package/docs/api/koatty.httpcontroller.ismethod.md +0 -26
  49. package/docs/api/koatty.httpcontroller.ispost.md +0 -19
  50. package/docs/api/koatty.httpcontroller.json.md +0 -26
  51. package/docs/api/koatty.httpcontroller.md +0 -35
  52. package/docs/api/koatty.httpcontroller.ok.md +0 -28
  53. package/docs/api/koatty.httpcontroller.param.md +0 -26
  54. package/docs/api/koatty.httpcontroller.redirect.md +0 -27
  55. package/docs/api/koatty.httpcontroller.type.md +0 -27
  56. package/docs/api/koatty.icontroller.__after.md +0 -11
  57. package/docs/api/koatty.icontroller.__befor.md +0 -11
  58. package/docs/api/koatty.icontroller.app.md +0 -11
  59. package/docs/api/koatty.icontroller.ctx.md +0 -11
  60. package/docs/api/koatty.icontroller.fail.md +0 -11
  61. package/docs/api/koatty.icontroller.md +0 -25
  62. package/docs/api/koatty.icontroller.ok.md +0 -11
  63. package/docs/api/koatty.imiddleware.md +0 -20
  64. package/docs/api/koatty.imiddleware.run.md +0 -11
  65. package/docs/api/koatty.iplugin.md +0 -20
  66. package/docs/api/koatty.iplugin.run.md +0 -11
  67. package/docs/api/koatty.iservice.app.md +0 -11
  68. package/docs/api/koatty.iservice.md +0 -20
  69. package/docs/api/koatty.logger.md +0 -11
  70. package/docs/api/koatty.md +0 -51
  71. package/docs/api/koatty.middleware.md +0 -27
  72. package/docs/api/koatty.plugin.md +0 -27
  73. package/docs/api/koatty.service.md +0 -27
  74. package/jest.config.js +0 -34
  75. package/jest_html_reporters.html +0 -60
  76. package/rollup.config.js +0 -63
  77. package/scripts/copyright.js +0 -28
  78. package/scripts/postBuild.js +0 -10
  79. package/tsconfig.json +0 -69
package/CHANGELOG.md CHANGED
@@ -2,4 +2,12 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ### [3.5.12](https://github.com/thinkkoa/koatty/compare/v3.5.12-3...v3.5.12) (2021-12-23)
6
+
7
+ ### [3.5.12-3](https://github.com/thinkkoa/koatty/compare/v3.5.12-2...v3.5.12-3) (2021-12-23)
8
+
9
+ ### [3.5.12-2](https://github.com/thinkkoa/koatty/compare/v3.5.12-1...v3.5.12-2) (2021-12-21)
10
+
11
+ ### [3.5.12-1](https://github.com/thinkkoa/koatty/compare/v3.5.12-0...v3.5.12-1) (2021-12-21)
12
+
5
13
  ### [3.5.12-0](https://github.com/thinkkoa/koatty/compare/v3.5.10...v3.5.12-0) (2021-12-21)
package/dist/index.d.ts CHANGED
@@ -1,14 +1,14 @@
1
1
  /*!
2
2
  * @Author: richen
3
- * @Date: 2021-12-21 12:22:04
3
+ * @Date: 2021-12-23 15:31:27
4
4
  * @License: BSD (3-Clause)
5
5
  * @Copyright (c) - <richenlin(at)gmail.com>
6
6
  * @HomePage: https://koatty.org/
7
7
  */
8
8
  import { Helper } from 'koatty_lib';
9
- import Koa from 'koa';
10
9
  import { Koatty } from 'koatty_core';
11
10
  import { KoattyContext } from 'koatty_core';
11
+ import { KoattyNext } from 'koatty_core';
12
12
  import { Logger as Logger_2 } from 'koatty_logger';
13
13
  import { ObjectDefinitionOptions } from 'koatty_container';
14
14
 
@@ -306,7 +306,7 @@ export declare interface IController {
306
306
  * Interface for Middleware
307
307
  */
308
308
  export declare interface IMiddleware {
309
- run: (options: any, app: Koatty) => Koa.Middleware;
309
+ run: (options: any, app: Koatty) => KoattyMiddleware;
310
310
  }
311
311
 
312
312
  /**
@@ -323,6 +323,11 @@ export declare interface IService {
323
323
  app: Koatty;
324
324
  }
325
325
 
326
+ /**
327
+ * Interface for Middleware
328
+ */
329
+ export declare type KoattyMiddleware = (ctx: KoattyContext, next: KoattyNext) => Promise<any>;
330
+
326
331
  export declare const Logger: Logger_2;
327
332
 
328
333
  /**
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * @Author: richen
3
- * @Date: 2021-12-21 12:21:50
3
+ * @Date: 2021-12-23 15:31:08
4
4
  * @License: BSD (3-Clause)
5
5
  * @Copyright (c) - <richenlin(at)gmail.com>
6
6
  * @HomePage: https://koatty.org/
@@ -903,7 +903,7 @@ class Loader {
903
903
  }
904
904
  }
905
905
 
906
- var version = "3.5.12-0";
906
+ var version = "3.5.12";
907
907
  var engines = {
908
908
  node: ">12.0.0"
909
909
  };
package/dist/index.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * @Author: richen
3
- * @Date: 2021-12-21 12:21:50
3
+ * @Date: 2021-12-23 15:31:08
4
4
  * @License: BSD (3-Clause)
5
5
  * @Copyright (c) - <richenlin(at)gmail.com>
6
6
  * @HomePage: https://koatty.org/
@@ -886,7 +886,7 @@ class Loader {
886
886
  }
887
887
  }
888
888
 
889
- var version = "3.5.12-0";
889
+ var version = "3.5.12";
890
890
  var engines = {
891
891
  node: ">12.0.0"
892
892
  };
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "koatty",
3
- "version": "3.5.12-0",
3
+ "version": "3.5.12",
4
4
  "description": "Koa2 + Typescript = koatty. Use Typescript's decorator implement auto injection.",
5
5
  "scripts": {
6
6
  "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
@@ -22,10 +22,9 @@
22
22
  },
23
23
  "main": "./dist/index.js",
24
24
  "exports": {
25
- "require": "./index.js",
26
- "import": "./index.mjs"
25
+ "require": "./dist/index.js",
26
+ "import": "./dist/index.mjs"
27
27
  },
28
- "typings": "index.d.ts",
29
28
  "directories": {
30
29
  "doc": "docs"
31
30
  },
@@ -83,16 +82,16 @@
83
82
  "dependencies": {
84
83
  "koa": "^2.13.4",
85
84
  "koatty_config": "^1.0.6",
86
- "koatty_container": "^1.6.12",
87
- "koatty_core": "^1.4.6",
85
+ "koatty_container": "^1.6.16",
86
+ "koatty_core": "^1.4.14",
88
87
  "koatty_exception": "^1.0.6",
89
88
  "koatty_lib": "^1.2.8",
90
89
  "koatty_loader": "^1.0.2",
91
90
  "koatty_logger": "^1.3.12",
92
91
  "koatty_payload": "^1.3.10",
93
- "koatty_router": "^1.6.2",
94
- "koatty_serve": "^1.4.2",
95
- "koatty_trace": "^1.5.0",
92
+ "koatty_router": "^1.6.4",
93
+ "koatty_serve": "^1.4.4",
94
+ "koatty_trace": "^1.5.2",
96
95
  "reflect-metadata": "^0.1.13",
97
96
  "tslib": "^2.3.1"
98
97
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "koatty",
3
- "version": "3.5.12-0",
3
+ "version": "3.5.12",
4
4
  "description": "Koa2 + Typescript = koatty. Use Typescript's decorator implement auto injection.",
5
5
  "scripts": {
6
6
  "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
@@ -22,10 +22,9 @@
22
22
  },
23
23
  "main": "./dist/index.js",
24
24
  "exports": {
25
- "require": "./index.js",
26
- "import": "./index.mjs"
25
+ "require": "./dist/index.js",
26
+ "import": "./dist/index.mjs"
27
27
  },
28
- "typings": "index.d.ts",
29
28
  "directories": {
30
29
  "doc": "docs"
31
30
  },
@@ -83,16 +82,16 @@
83
82
  "dependencies": {
84
83
  "koa": "^2.13.4",
85
84
  "koatty_config": "^1.0.6",
86
- "koatty_container": "^1.6.12",
87
- "koatty_core": "^1.4.6",
85
+ "koatty_container": "^1.6.16",
86
+ "koatty_core": "^1.4.14",
88
87
  "koatty_exception": "^1.0.6",
89
88
  "koatty_lib": "^1.2.8",
90
89
  "koatty_loader": "^1.0.2",
91
90
  "koatty_logger": "^1.3.12",
92
91
  "koatty_payload": "^1.3.10",
93
- "koatty_router": "^1.6.2",
94
- "koatty_serve": "^1.4.2",
95
- "koatty_trace": "^1.5.0",
92
+ "koatty_router": "^1.6.4",
93
+ "koatty_serve": "^1.4.4",
94
+ "koatty_trace": "^1.5.2",
96
95
  "reflect-metadata": "^0.1.13",
97
96
  "tslib": "^2.3.1"
98
97
  }
package/.commitlintrc.js DELETED
@@ -1,3 +0,0 @@
1
- module.exports = {
2
- extends: ["gitmoji"],
3
- };
package/.eslintignore DELETED
@@ -1,11 +0,0 @@
1
- node_modules
2
- .eslintrc.js
3
- **/package-lock.json
4
- **/yarn.lock
5
- **/*.config.js
6
- dist
7
- temp
8
- scripts
9
- coverage
10
- test
11
- demo
package/.eslintrc.js DELETED
@@ -1,43 +0,0 @@
1
- /**
2
- *
3
- */
4
- module.exports = {
5
- root: true,
6
- parser: '@typescript-eslint/parser',
7
- extends: [
8
- 'plugin:@typescript-eslint/recommended', // 使用@typescript-eslint/eslint-plugin的推荐规则
9
- 'plugin:jest/recommended',
10
- ],
11
- plugins: [
12
- '@typescript-eslint',
13
- 'jest',
14
- ],
15
- parserOptions: {
16
- project: './tsconfig.json',
17
- },
18
- env: {
19
- node: true,
20
- mongo: true,
21
- jest: true,
22
- },
23
- rules: {
24
- "@typescript-eslint/no-explicit-any": "off",
25
- // "@typescript-eslint/no-require-imports": "off",
26
- "@typescript-eslint/no-var-requires": "off",
27
- "@typescript-eslint/member-ordering": "off",
28
- "@typescript-eslint/consistent-type-assertions": "off",
29
- "@typescript-eslint/no-param-reassign": "off",
30
- "@typescript-eslint/no-empty-function": "off",
31
- "@typescript-eslint/no-empty-interface": "off",
32
- "@typescript-eslint/explicit-module-boundary-types": "off",
33
- "@typescript-eslint/ban-types": ["error",
34
- {
35
- "types": {
36
- "Object": false,
37
- "Function": false,
38
- },
39
- "extendDefaults": true
40
- }
41
- ],
42
- },
43
- };
package/.huskyrc DELETED
@@ -1,5 +0,0 @@
1
- {
2
- "hooks": {
3
- "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS"
4
- }
5
- }
package/.versionrc.js DELETED
@@ -1,16 +0,0 @@
1
- module.exports = {
2
- // skip: {
3
- // tag: true,
4
- // },
5
- //server-version自动commit的模板
6
- releaseCommitMessageFormat:
7
- "🔧 build: v{{currentTag}}",
8
- //需要server-version更新版本号的文件
9
- bumpFiles: [
10
- {
11
- filename: "package.json",
12
- // The `json` updater assumes the version is available under a `version` key in the provided JSON document.
13
- type: "json",
14
- },
15
- ],
16
- };
@@ -1,345 +0,0 @@
1
- /**
2
- * Config file for API Extractor. For more info, please visit: https://api-extractor.com
3
- */
4
- {
5
- "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
6
- /**
7
- * Optionally specifies another JSON config file that this file extends from. This provides a way for
8
- * standard settings to be shared across multiple projects.
9
- *
10
- * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
11
- * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be
12
- * resolved using NodeJS require().
13
- *
14
- * SUPPORTED TOKENS: none
15
- * DEFAULT VALUE: ""
16
- */
17
- // "extends": "./shared/api-extractor-base.json"
18
- // "extends": "my-package/include/api-extractor-base.json"
19
- /**
20
- * Determines the "<projectFolder>" token that can be used with other config file settings. The project folder
21
- * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
22
- *
23
- * The path is resolved relative to the folder of the config file that contains the setting.
24
- *
25
- * The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
26
- * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
27
- * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error
28
- * will be reported.
29
- *
30
- * SUPPORTED TOKENS: <lookup>
31
- * DEFAULT VALUE: "<lookup>"
32
- */
33
- // "projectFolder": "..",
34
- /**
35
- * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor
36
- * analyzes the symbols exported by this module.
37
- *
38
- * The file extension must be ".d.ts" and not ".ts".
39
- *
40
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
41
- * prepend a folder token such as "<projectFolder>".
42
- *
43
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
44
- */
45
- "mainEntryPointFilePath": "<projectFolder>/temp/src/index.d.ts",
46
- /**
47
- * A list of NPM package names whose exports should be treated as part of this package.
48
- *
49
- * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1",
50
- * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part
51
- * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly
52
- * imports library2. To avoid this, we can specify:
53
- *
54
- * "bundledPackages": [ "library2" ],
55
- *
56
- * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
57
- * local files for library1.
58
- */
59
- "bundledPackages": [],
60
- /**
61
- * Determines how the TypeScript compiler engine will be invoked by API Extractor.
62
- */
63
- "compiler": {
64
- /**
65
- * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
66
- *
67
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
68
- * prepend a folder token such as "<projectFolder>".
69
- *
70
- * Note: This setting will be ignored if "overrideTsconfig" is used.
71
- *
72
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
73
- * DEFAULT VALUE: "<projectFolder>/tsconfig.json"
74
- */
75
- // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
76
- /**
77
- * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
78
- * The object must conform to the TypeScript tsconfig schema:
79
- *
80
- * http://json.schemastore.org/tsconfig
81
- *
82
- * If omitted, then the tsconfig.json file will be read from the "projectFolder".
83
- *
84
- * DEFAULT VALUE: no overrideTsconfig section
85
- */
86
- // "overrideTsconfig": {
87
- // . . .
88
- // }
89
- /**
90
- * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
91
- * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
92
- * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
93
- * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
94
- *
95
- * DEFAULT VALUE: false
96
- */
97
- // "skipLibCheck": true,
98
- },
99
- /**
100
- * Configures how the API report file (*.api.md) will be generated.
101
- */
102
- "apiReport": {
103
- /**
104
- * (REQUIRED) Whether to generate an API report.
105
- */
106
- "enabled": false
107
- /**
108
- * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce
109
- * a full file path.
110
- *
111
- * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
112
- *
113
- * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
114
- * DEFAULT VALUE: "<unscopedPackageName>.api.md"
115
- */
116
- // "reportFileName": "<unscopedPackageName>.api.md",
117
- /**
118
- * Specifies the folder where the API report file is written. The file name portion is determined by
119
- * the "reportFileName" setting.
120
- *
121
- * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy,
122
- * e.g. for an API review.
123
- *
124
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
125
- * prepend a folder token such as "<projectFolder>".
126
- *
127
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
128
- * DEFAULT VALUE: "<projectFolder>/etc/"
129
- */
130
- // "reportFolder": "<projectFolder>/etc/",
131
- /**
132
- * Specifies the folder where the temporary report file is written. The file name portion is determined by
133
- * the "reportFileName" setting.
134
- *
135
- * After the temporary file is written to disk, it is compared with the file in the "reportFolder".
136
- * If they are different, a production build will fail.
137
- *
138
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
139
- * prepend a folder token such as "<projectFolder>".
140
- *
141
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
142
- * DEFAULT VALUE: "<projectFolder>/temp/"
143
- */
144
- // "reportTempFolder": "<projectFolder>/temp/"
145
- },
146
- /**
147
- * Configures how the doc model file (*.api.json) will be generated.
148
- */
149
- "docModel": {
150
- /**
151
- * (REQUIRED) Whether to generate a doc model file.
152
- */
153
- "enabled": true
154
- /**
155
- * The output path for the doc model file. The file extension should be ".api.json".
156
- *
157
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
158
- * prepend a folder token such as "<projectFolder>".
159
- *
160
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
161
- * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
162
- */
163
- // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
164
- },
165
- /**
166
- * Configures how the .d.ts rollup file will be generated.
167
- */
168
- "dtsRollup": {
169
- /**
170
- * (REQUIRED) Whether to generate the .d.ts rollup file.
171
- */
172
- "enabled": true,
173
- /**
174
- * Specifies the output path for a .d.ts rollup file to be generated without any trimming.
175
- * This file will include all declarations that are exported by the main entry point.
176
- *
177
- * If the path is an empty string, then this file will not be written.
178
- *
179
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
180
- * prepend a folder token such as "<projectFolder>".
181
- *
182
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
183
- * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
184
- */
185
- "untrimmedFilePath": "",
186
- /**
187
- * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
188
- * This file will include only declarations that are marked as "@public" or "@beta".
189
- *
190
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
191
- * prepend a folder token such as "<projectFolder>".
192
- *
193
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
194
- * DEFAULT VALUE: ""
195
- */
196
- // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
197
- /**
198
- * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
199
- * This file will include only declarations that are marked as "@public".
200
- *
201
- * If the path is an empty string, then this file will not be written.
202
- *
203
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
204
- * prepend a folder token such as "<projectFolder>".
205
- *
206
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
207
- * DEFAULT VALUE: ""
208
- */
209
- "publicTrimmedFilePath": "<projectFolder>/dist/index.d.ts",
210
- /**
211
- * When a declaration is trimmed, by default it will be replaced by a code comment such as
212
- * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the
213
- * declaration completely.
214
- *
215
- * DEFAULT VALUE: false
216
- */
217
- "omitTrimmingComments": true
218
- },
219
- /**
220
- * Configures how the tsdoc-metadata.json file will be generated.
221
- */
222
- "tsdocMetadata": {
223
- /**
224
- * Whether to generate the tsdoc-metadata.json file.
225
- *
226
- * DEFAULT VALUE: true
227
- */
228
- "enabled": false
229
- /**
230
- * Specifies where the TSDoc metadata file should be written.
231
- *
232
- * The path is resolved relative to the folder of the config file that contains the setting; to change this,
233
- * prepend a folder token such as "<projectFolder>".
234
- *
235
- * The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
236
- * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup
237
- * falls back to "tsdoc-metadata.json" in the package folder.
238
- *
239
- * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
240
- * DEFAULT VALUE: "<lookup>"
241
- */
242
- // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
243
- },
244
- /**
245
- * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files
246
- * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead.
247
- * To use the OS's default newline kind, specify "os".
248
- *
249
- * DEFAULT VALUE: "crlf"
250
- */
251
- // "newlineKind": "crlf",
252
- /**
253
- * Configures how API Extractor reports error and warning messages produced during analysis.
254
- *
255
- * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages.
256
- */
257
- "messages": {
258
- /**
259
- * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
260
- * the input .d.ts files.
261
- *
262
- * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551"
263
- *
264
- * DEFAULT VALUE: A single "default" entry with logLevel=warning.
265
- */
266
- "compilerMessageReporting": {
267
- /**
268
- * Configures the default routing for messages that don't match an explicit rule in this table.
269
- */
270
- "default": {
271
- /**
272
- * Specifies whether the message should be written to the the tool's output log. Note that
273
- * the "addToApiReportFile" property may supersede this option.
274
- *
275
- * Possible values: "error", "warning", "none"
276
- *
277
- * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail
278
- * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes
279
- * the "--local" option), the warning is displayed but the build will not fail.
280
- *
281
- * DEFAULT VALUE: "warning"
282
- */
283
- "logLevel": "warning"
284
- /**
285
- * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md),
286
- * then the message will be written inside that file; otherwise, the message is instead logged according to
287
- * the "logLevel" option.
288
- *
289
- * DEFAULT VALUE: false
290
- */
291
- // "addToApiReportFile": false
292
- }
293
- // "TS2551": {
294
- // "logLevel": "warning",
295
- // "addToApiReportFile": true
296
- // },
297
- //
298
- // . . .
299
- },
300
- /**
301
- * Configures handling of messages reported by API Extractor during its analysis.
302
- *
303
- * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag"
304
- *
305
- * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
306
- */
307
- "extractorMessageReporting": {
308
- "default": {
309
- "logLevel": "warning"
310
- // "addToApiReportFile": false
311
- },
312
- "ae-missing-release-tag": {
313
- "logLevel": "none"
314
- }
315
- // "ae-extra-release-tag": {
316
- // "logLevel": "warning",
317
- // "addToApiReportFile": true
318
- // },
319
- //
320
- // . . .
321
- },
322
- /**
323
- * Configures handling of messages reported by the TSDoc parser when analyzing code comments.
324
- *
325
- * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text"
326
- *
327
- * DEFAULT VALUE: A single "default" entry with logLevel=warning.
328
- */
329
- "tsdocMessageReporting": {
330
- "default": {
331
- "logLevel": "warning"
332
- // "addToApiReportFile": false
333
- },
334
- "tsdoc-param-tag-missing-hyphen": {
335
- "logLevel": "none"
336
- }
337
- // "tsdoc-link-tag-unescaped-text": {
338
- // "logLevel": "warning",
339
- // "addToApiReportFile": true
340
- // },
341
- //
342
- // . . .
343
- }
344
- }
345
- }
package/docs/api/index.md DELETED
@@ -1,12 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md)
4
-
5
- ## API Reference
6
-
7
- ## Packages
8
-
9
- | Package | Description |
10
- | --- | --- |
11
- | [koatty](./koatty.md) | |
12
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiInput](./koatty.apiinput.md) &gt; [code](./koatty.apiinput.code.md)
4
-
5
- ## ApiInput.code property
6
-
7
- <b>Signature:</b>
8
-
9
- ```typescript
10
- code?: number;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiInput](./koatty.apiinput.md) &gt; [data](./koatty.apiinput.data.md)
4
-
5
- ## ApiInput.data property
6
-
7
- <b>Signature:</b>
8
-
9
- ```typescript
10
- data?: any;
11
- ```
@@ -1,22 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiInput](./koatty.apiinput.md)
4
-
5
- ## ApiInput interface
6
-
7
- Interface for Api input
8
-
9
- <b>Signature:</b>
10
-
11
- ```typescript
12
- export interface ApiInput
13
- ```
14
-
15
- ## Properties
16
-
17
- | Property | Type | Description |
18
- | --- | --- | --- |
19
- | [code?](./koatty.apiinput.code.md) | number | <i>(Optional)</i> |
20
- | [data?](./koatty.apiinput.data.md) | any | <i>(Optional)</i> |
21
- | [message?](./koatty.apiinput.message.md) | string | <i>(Optional)</i> |
22
-