@powerlines/plugin-alloy 0.15.7 → 0.15.8
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/dist/{chunk-CLCJnD51.mjs → _virtual/rolldown_runtime.cjs} +3 -5
- package/dist/{chunk-BrXtsOCC.cjs → _virtual/rolldown_runtime.mjs} +8 -20
- package/dist/core/components/index.cjs +6 -9
- package/dist/core/components/index.d.cts +3 -6
- package/dist/core/components/index.d.mts +3 -6
- package/dist/core/components/index.mjs +3 -6
- package/dist/core/components/output.cjs +39 -4
- package/dist/core/components/output.d.cts +17 -2
- package/dist/core/components/output.d.mts +17 -2
- package/dist/core/components/output.mjs +37 -3
- package/dist/core/components/single-line-comment.cjs +21 -3
- package/dist/core/components/single-line-comment.d.cts +21 -3
- package/dist/core/components/single-line-comment.d.mts +21 -3
- package/dist/core/components/single-line-comment.mjs +19 -2
- package/dist/core/components/source-file.cjs +57 -3
- package/dist/core/components/source-file.d.cts +30 -3
- package/dist/core/components/source-file.d.mts +30 -3
- package/dist/core/components/source-file.mjs +54 -2
- package/dist/core/contexts/context.cjs +28 -5
- package/dist/core/contexts/context.d.cts +25 -2
- package/dist/core/contexts/context.d.mts +25 -2
- package/dist/core/contexts/context.mjs +24 -2
- package/dist/core/contexts/index.cjs +13 -15
- package/dist/core/contexts/index.d.cts +2 -5
- package/dist/core/contexts/index.d.mts +2 -6
- package/dist/core/contexts/index.mjs +2 -4
- package/dist/core/contexts/reflection.cjs +67 -10
- package/dist/core/contexts/reflection.d.cts +50 -3
- package/dist/core/contexts/reflection.d.mts +50 -4
- package/dist/core/contexts/reflection.mjs +58 -2
- package/dist/core/index.cjs +21 -22
- package/dist/core/index.d.cts +7 -9
- package/dist/core/index.d.mts +7 -10
- package/dist/core/index.mjs +7 -8
- package/dist/deepkit/src/utilities.cjs +112 -0
- package/dist/deepkit/src/utilities.mjs +108 -0
- package/dist/helpers/capnp.cjs +274 -18
- package/dist/helpers/capnp.d.cts +85 -2
- package/dist/helpers/capnp.d.mts +85 -3
- package/dist/helpers/capnp.mjs +255 -1
- package/dist/helpers/create-builtin.cjs +18 -2
- package/dist/helpers/create-builtin.d.cts +14 -1
- package/dist/helpers/create-builtin.d.mts +14 -1
- package/dist/helpers/create-builtin.mjs +16 -1
- package/dist/helpers/index.cjs +23 -24
- package/dist/helpers/index.d.cts +4 -5
- package/dist/helpers/index.d.mts +4 -6
- package/dist/helpers/index.mjs +4 -5
- package/dist/helpers/refkey.cjs +15 -3
- package/dist/helpers/refkey.d.cts +12 -1
- package/dist/helpers/refkey.d.mts +12 -1
- package/dist/helpers/refkey.mjs +13 -2
- package/dist/helpers/typescript.cjs +45 -2
- package/dist/helpers/typescript.d.cts +22 -1
- package/dist/helpers/typescript.d.mts +22 -2
- package/dist/helpers/typescript.mjs +43 -1
- package/dist/index.cjs +25 -271
- package/dist/index.d.cts +2 -3
- package/dist/index.d.mts +2 -3
- package/dist/index.mjs +23 -23
- package/dist/markdown/components/index.cjs +7 -13
- package/dist/markdown/components/index.d.cts +2 -7
- package/dist/markdown/components/index.d.mts +2 -7
- package/dist/markdown/components/index.mjs +2 -8
- package/dist/markdown/components/markdown-file.cjs +117 -7
- package/dist/markdown/components/markdown-file.d.cts +22 -4
- package/dist/markdown/components/markdown-file.d.mts +22 -4
- package/dist/markdown/components/markdown-file.mjs +114 -5
- package/dist/markdown/components/markdown-table.cjs +100 -6
- package/dist/markdown/components/markdown-table.d.cts +26 -4
- package/dist/markdown/components/markdown-table.d.mts +26 -4
- package/dist/markdown/components/markdown-table.mjs +96 -3
- package/dist/markdown/contexts/index.cjs +5 -7
- package/dist/markdown/contexts/index.d.cts +1 -2
- package/dist/markdown/contexts/index.d.mts +1 -2
- package/dist/markdown/contexts/index.mjs +1 -3
- package/dist/markdown/contexts/markdown-table.cjs +36 -6
- package/dist/markdown/contexts/markdown-table.d.cts +36 -1
- package/dist/markdown/contexts/markdown-table.d.mts +36 -1
- package/dist/markdown/contexts/markdown-table.mjs +31 -2
- package/dist/markdown/index.cjs +14 -18
- package/dist/markdown/index.d.cts +5 -8
- package/dist/markdown/index.d.mts +5 -8
- package/dist/markdown/index.mjs +5 -9
- package/dist/powerlines/src/lib/utilities/file-header.cjs +13 -0
- package/dist/powerlines/src/lib/utilities/file-header.mjs +12 -0
- package/dist/powerlines/src/types/babel.d.mts +2 -0
- package/dist/powerlines/src/types/build.d.cts +145 -0
- package/dist/powerlines/src/types/build.d.mts +145 -0
- package/dist/powerlines/src/types/commands.d.cts +8 -0
- package/dist/powerlines/src/types/commands.d.mts +9 -0
- package/dist/powerlines/src/types/config.d.cts +369 -0
- package/dist/powerlines/src/types/config.d.mts +369 -0
- package/dist/powerlines/src/types/context.d.cts +362 -0
- package/dist/powerlines/src/types/context.d.mts +364 -0
- package/dist/powerlines/src/types/fs.d.cts +458 -0
- package/dist/powerlines/src/types/fs.d.mts +458 -0
- package/dist/powerlines/src/types/hooks.d.mts +2 -0
- package/dist/powerlines/src/types/plugin.d.cts +231 -0
- package/dist/powerlines/src/types/plugin.d.mts +231 -0
- package/dist/powerlines/src/types/resolved.d.cts +81 -0
- package/dist/powerlines/src/types/resolved.d.mts +81 -0
- package/dist/powerlines/src/types/tsconfig.d.cts +69 -0
- package/dist/powerlines/src/types/tsconfig.d.mts +69 -0
- package/dist/types/components.cjs +0 -1
- package/dist/types/components.d.cts +141 -2
- package/dist/types/components.d.mts +141 -2
- package/dist/types/components.mjs +0 -2
- package/dist/types/index.cjs +0 -2
- package/dist/types/index.d.cts +2 -3
- package/dist/types/index.d.mts +2 -3
- package/dist/types/index.mjs +0 -3
- package/dist/types/plugin.cjs +0 -1
- package/dist/types/plugin.d.cts +40 -2
- package/dist/types/plugin.d.mts +40 -2
- package/dist/types/plugin.mjs +0 -2
- package/dist/typescript/components/builtin-file.cjs +43 -8
- package/dist/typescript/components/builtin-file.d.cts +33 -6
- package/dist/typescript/components/builtin-file.d.mts +33 -6
- package/dist/typescript/components/builtin-file.mjs +41 -7
- package/dist/typescript/components/dynamic-import-statement.cjs +24 -3
- package/dist/typescript/components/dynamic-import-statement.d.cts +31 -1
- package/dist/typescript/components/dynamic-import-statement.d.mts +31 -1
- package/dist/typescript/components/dynamic-import-statement.mjs +22 -2
- package/dist/typescript/components/entry-file.cjs +38 -7
- package/dist/typescript/components/entry-file.d.cts +26 -5
- package/dist/typescript/components/entry-file.d.mts +26 -5
- package/dist/typescript/components/entry-file.mjs +35 -6
- package/dist/typescript/components/index.cjs +43 -49
- package/dist/typescript/components/index.d.cts +9 -13
- package/dist/typescript/components/index.d.mts +9 -14
- package/dist/typescript/components/index.mjs +9 -15
- package/dist/typescript/components/record-expression.cjs +11 -3
- package/dist/typescript/components/record-expression.d.cts +11 -1
- package/dist/typescript/components/record-expression.d.mts +11 -1
- package/dist/typescript/components/record-expression.mjs +9 -2
- package/dist/typescript/components/tsdoc-reflection.cjs +172 -8
- package/dist/typescript/components/tsdoc-reflection.d.cts +17 -4
- package/dist/typescript/components/tsdoc-reflection.d.mts +17 -4
- package/dist/typescript/components/tsdoc-reflection.mjs +168 -5
- package/dist/typescript/components/tsdoc.cjs +475 -23
- package/dist/typescript/components/tsdoc.d.cts +151 -3
- package/dist/typescript/components/tsdoc.d.mts +151 -3
- package/dist/typescript/components/tsdoc.mjs +454 -3
- package/dist/typescript/components/typescript-file.cjs +192 -8
- package/dist/typescript/components/typescript-file.d.cts +46 -4
- package/dist/typescript/components/typescript-file.d.mts +46 -4
- package/dist/typescript/components/typescript-file.mjs +188 -5
- package/dist/typescript/components/typescript-interface.cjs +67 -8
- package/dist/typescript/components/typescript-interface.d.cts +23 -3
- package/dist/typescript/components/typescript-interface.d.mts +23 -4
- package/dist/typescript/components/typescript-interface.mjs +64 -6
- package/dist/typescript/components/typescript-object.cjs +124 -8
- package/dist/typescript/components/typescript-object.d.cts +24 -3
- package/dist/typescript/components/typescript-object.d.mts +24 -4
- package/dist/typescript/components/typescript-object.mjs +121 -6
- package/dist/typescript/index.cjs +44 -49
- package/dist/typescript/index.d.cts +10 -13
- package/dist/typescript/index.d.mts +10 -14
- package/dist/typescript/index.mjs +10 -15
- package/dist/vendor.cjs +20 -0
- package/dist/vendor.d.cts +1 -0
- package/dist/vendor.d.ts +1 -0
- package/dist/vendor.js +12420 -0
- package/dist/vendor.mjs +11 -0
- package/package.json +25 -8
- package/dist/builtin-file-BTFY397y.d.mts +0 -34
- package/dist/builtin-file-Cc9EahS_.mjs +0 -42
- package/dist/builtin-file-Cx2gYmvj.cjs +0 -47
- package/dist/builtin-file-DZ0j7GQ3.d.cts +0 -34
- package/dist/capnp-Bej06Vo6.mjs +0 -259
- package/dist/capnp-CirEkAHB.d.cts +0 -86
- package/dist/capnp-kgq1Wxjw.d.mts +0 -87
- package/dist/capnp-uHWANTSk.cjs +0 -356
- package/dist/components-BK5Ml-fB.mjs +0 -1
- package/dist/components-BYyc8-6U.cjs +0 -0
- package/dist/components-C9Lp4xr5.mjs +0 -1
- package/dist/components-CNE_Nde0.mjs +0 -1
- package/dist/components-Cvpo9IEL.cjs +0 -0
- package/dist/components-DSpDVIf0.d.cts +0 -142
- package/dist/components-Gg416Czx.cjs +0 -0
- package/dist/components-ZbItRNLr.cjs +0 -0
- package/dist/components-cffsgxGP.d.mts +0 -142
- package/dist/components-pztyf7qk.mjs +0 -1
- package/dist/context-B6PdDHc7.d.cts +0 -26
- package/dist/context-BDpEChDc.cjs +0 -43
- package/dist/context-BRIdBgyT.d.mts +0 -1680
- package/dist/context-CWt70HA3.d.cts +0 -1680
- package/dist/context-uyV_b5LD.mjs +0 -26
- package/dist/context-wYPSb88-.d.mts +0 -26
- package/dist/contexts-CWIkvja3.mjs +0 -1
- package/dist/contexts-Do5bLA7f.cjs +0 -0
- package/dist/contexts-DzdhIC7G.cjs +0 -0
- package/dist/contexts-oubuaPo0.mjs +0 -1
- package/dist/create-builtin-Be3J_vqf.mjs +0 -18
- package/dist/create-builtin-BhPGJIAV.d.mts +0 -15
- package/dist/create-builtin-Bok_ENQo.d.cts +0 -15
- package/dist/create-builtin-eQVsnSGQ.cjs +0 -24
- package/dist/dynamic-import-statement-CKVyBkh0.cjs +0 -29
- package/dist/dynamic-import-statement-CQUyuOvA.mjs +0 -23
- package/dist/dynamic-import-statement-DcFHKm1U.d.mts +0 -32
- package/dist/dynamic-import-statement-Dv-agvo9.d.cts +0 -32
- package/dist/entry-file-BZUmlDWP.d.cts +0 -27
- package/dist/entry-file-CJVwkVNJ.mjs +0 -36
- package/dist/entry-file-Cw1Nykfb.cjs +0 -44
- package/dist/entry-file-Dvn4sgIC.d.mts +0 -27
- package/dist/index-Blaks7l8.d.cts +0 -1
- package/dist/index-BwFl_eS0.d.mts +0 -1
- package/dist/index-CCKHlTA4.d.mts +0 -1
- package/dist/index-CwSIy_W-.d.cts +0 -1
- package/dist/index-D13oYj4_.d.mts +0 -1
- package/dist/index-DBGd4WeR.d.mts +0 -1
- package/dist/index-DdxxIAKU.d.cts +0 -1
- package/dist/index-DrZ2Dh-H.d.cts +0 -1
- package/dist/index-gpCH5158.d.mts +0 -1
- package/dist/index-lQ_hGQ08.d.cts +0 -1
- package/dist/jsx-runtime-CUeGxIAS.mjs +0 -6617
- package/dist/jsx-runtime-DYxEHXau.cjs +0 -7511
- package/dist/markdown-file-BMWEBCyl.cjs +0 -127
- package/dist/markdown-file-Cfrqc-hN.mjs +0 -115
- package/dist/markdown-file-DUSLyCXK.d.cts +0 -23
- package/dist/markdown-file-nmspmOXL.d.mts +0 -23
- package/dist/markdown-table-BH93E_KU.d.cts +0 -27
- package/dist/markdown-table-BOFmeE2m.d.mts +0 -27
- package/dist/markdown-table-CBzXYSUb.cjs +0 -56
- package/dist/markdown-table-CqyI4NbJ.d.cts +0 -37
- package/dist/markdown-table-D7tYGUEd.mjs +0 -97
- package/dist/markdown-table-DB3e0UqW.d.mts +0 -37
- package/dist/markdown-table-DCJGVRji.mjs +0 -33
- package/dist/markdown-table-DJnMnLrC.cjs +0 -116
- package/dist/output-BwrSWhh_.cjs +0 -45
- package/dist/output-C5E9Yg_M.d.mts +0 -18
- package/dist/output-CwItdY-C.mjs +0 -38
- package/dist/output-dEdF2_eK.d.cts +0 -18
- package/dist/plugin-CB4x_Q7V.d.mts +0 -40
- package/dist/plugin-CihR7e46.d.cts +0 -40
- package/dist/plugin-CofWgH_d.cjs +0 -0
- package/dist/plugin-DYr7uFlI.mjs +0 -1
- package/dist/record-expression-AF7Vq6a_.d.cts +0 -12
- package/dist/record-expression-B3Ey9GU1.d.mts +0 -12
- package/dist/record-expression-BAmHoqT_.mjs +0 -11
- package/dist/record-expression-Dib5JNnw.cjs +0 -16
- package/dist/refkey-1S6o7FvP.cjs +0 -20
- package/dist/refkey-Bde1cIzZ.d.cts +0 -13
- package/dist/refkey-JNhwrUqU.d.mts +0 -13
- package/dist/refkey-MvGS-pyo.mjs +0 -15
- package/dist/reflection-50U0xo4F.d.mts +0 -52
- package/dist/reflection-CEg9I3Z-.cjs +0 -107
- package/dist/reflection-DdUbSUpz.d.cts +0 -51
- package/dist/reflection-rAKwnBc8.mjs +0 -60
- package/dist/single-line-comment-BlsLcI_G.d.cts +0 -22
- package/dist/single-line-comment-CwrahJhq.d.mts +0 -22
- package/dist/single-line-comment-LR74JZLa.mjs +0 -20
- package/dist/single-line-comment-LhhrQO3v.cjs +0 -25
- package/dist/source-file-B3nELUUN.cjs +0 -62
- package/dist/source-file-BhgOu1Wr.d.mts +0 -31
- package/dist/source-file-CusamdN4.d.cts +0 -31
- package/dist/source-file-CxzTxqAg.mjs +0 -55
- package/dist/tsdoc-97Dh6htZ.cjs +0 -575
- package/dist/tsdoc-BMyugfPn.d.mts +0 -152
- package/dist/tsdoc-D2BVcBJd.mjs +0 -455
- package/dist/tsdoc-DWIcbd8M.d.cts +0 -152
- package/dist/tsdoc-reflection-B66tRNu1.d.cts +0 -18
- package/dist/tsdoc-reflection-BTAFEc-s.cjs +0 -188
- package/dist/tsdoc-reflection-CBEWiA-g.d.mts +0 -18
- package/dist/tsdoc-reflection-DOgVWcNP.mjs +0 -169
- package/dist/type-f5ttv0My.d.mts +0 -3
- package/dist/typescript-BXhP0qIJ.mjs +0 -45
- package/dist/typescript-BwiYpbhk.cjs +0 -51
- package/dist/typescript-DNBFhP72.d.mts +0 -25
- package/dist/typescript-YczHz9BQ.d.cts +0 -23
- package/dist/typescript-file-BMGxgxo7.cjs +0 -207
- package/dist/typescript-file-BqxyTQ52.d.cts +0 -47
- package/dist/typescript-file-CAT-CIk2.mjs +0 -189
- package/dist/typescript-file-CxDEGozE.d.mts +0 -47
- package/dist/typescript-interface-BGdhcY-U.d.cts +0 -24
- package/dist/typescript-interface-CTw2F_uD.d.mts +0 -25
- package/dist/typescript-interface-CqST5f2X.cjs +0 -79
- package/dist/typescript-interface-WZX7BAi8.mjs +0 -66
- package/dist/typescript-object-65Ei0RFv.d.cts +0 -25
- package/dist/typescript-object-C8Wd0Uhv.d.mts +0 -26
- package/dist/typescript-object-D1y6Cvnl.mjs +0 -122
- package/dist/typescript-object-KhCP_Nc8.cjs +0 -135
|
@@ -1,24 +1,476 @@
|
|
|
1
|
-
require('../../
|
|
2
|
-
require('../../context
|
|
3
|
-
const
|
|
1
|
+
const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
|
|
2
|
+
const require_core_contexts_context = require('../../core/contexts/context.cjs');
|
|
3
|
+
const require_utilities = require('../../deepkit/src/utilities.cjs');
|
|
4
|
+
let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
|
|
5
|
+
let __stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
|
|
6
|
+
let __powerlines_plugin_alloy_vendor = require("@powerlines/plugin-alloy/vendor");
|
|
7
|
+
let __stryke_type_checks_is_undefined = require("@stryke/type-checks/is-undefined");
|
|
4
8
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
9
|
+
//#region src/typescript/components/tsdoc.tsx
|
|
10
|
+
/**
|
|
11
|
+
* Generates a TypeScript interface for the given reflection class.
|
|
12
|
+
*/
|
|
13
|
+
function TSDoc(props) {
|
|
14
|
+
const [{ children, heading }] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, ["children", "heading"]);
|
|
15
|
+
return [
|
|
16
|
+
"/**",
|
|
17
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
|
|
18
|
+
string: " * ",
|
|
19
|
+
get children() {
|
|
20
|
+
return [
|
|
21
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
22
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
23
|
+
get when() {
|
|
24
|
+
return !(0, __stryke_type_checks_is_undefined.isUndefined)(heading);
|
|
25
|
+
},
|
|
26
|
+
get children() {
|
|
27
|
+
return [
|
|
28
|
+
heading,
|
|
29
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
30
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
31
|
+
get when() {
|
|
32
|
+
return (0, __alloy_js_core_jsx_runtime.memo)(() => !!!(0, __stryke_type_checks_is_undefined.isUndefined)(children))() && (0, __powerlines_plugin_alloy_vendor.childrenArray)(() => children).length > 0;
|
|
33
|
+
},
|
|
34
|
+
get children() {
|
|
35
|
+
return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {});
|
|
36
|
+
}
|
|
37
|
+
})
|
|
38
|
+
];
|
|
39
|
+
}
|
|
40
|
+
}),
|
|
41
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
42
|
+
get when() {
|
|
43
|
+
return (0, __alloy_js_core_jsx_runtime.memo)(() => !!!(0, __stryke_type_checks_is_undefined.isUndefined)(children))() && (0, __powerlines_plugin_alloy_vendor.childrenArray)(() => children).length > 0;
|
|
44
|
+
},
|
|
45
|
+
get children() {
|
|
46
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.List, { get children() {
|
|
47
|
+
return (0, __powerlines_plugin_alloy_vendor.childrenArray)(() => children);
|
|
48
|
+
} });
|
|
49
|
+
}
|
|
50
|
+
})
|
|
51
|
+
];
|
|
52
|
+
}
|
|
53
|
+
}),
|
|
54
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
55
|
+
` */`,
|
|
56
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
|
|
57
|
+
];
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Create a TSDoc `@<props.tag>` tag.
|
|
61
|
+
*/
|
|
62
|
+
function TSDocTag(props) {
|
|
63
|
+
const [{ children, tag }] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, ["children", "tag"]);
|
|
64
|
+
return [
|
|
65
|
+
`@${tag} `,
|
|
66
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
67
|
+
get when() {
|
|
68
|
+
return Boolean(children);
|
|
69
|
+
},
|
|
70
|
+
get children() {
|
|
71
|
+
return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
|
|
72
|
+
width: 2,
|
|
73
|
+
get children() {
|
|
74
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Prose, { children });
|
|
75
|
+
}
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
}),
|
|
79
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
|
|
80
|
+
];
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* A component that creates a TSDoc block with `@param` tags for each parameter.
|
|
84
|
+
*/
|
|
85
|
+
function TSDocParams(props) {
|
|
86
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.For, {
|
|
87
|
+
each: normalizeParametersForDoc(props.parameters),
|
|
88
|
+
children: (param) => (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocParam, {
|
|
89
|
+
get name() {
|
|
90
|
+
return param.name;
|
|
91
|
+
},
|
|
92
|
+
get optional() {
|
|
93
|
+
return param.optional;
|
|
94
|
+
},
|
|
95
|
+
get children() {
|
|
96
|
+
return param.doc;
|
|
97
|
+
}
|
|
98
|
+
})
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
function normalizeParametersForDoc(parameters) {
|
|
102
|
+
if (parameters.some((p) => typeof p === "string")) return [];
|
|
103
|
+
return parameters;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Create a TSDoc `@title` tag.
|
|
107
|
+
*/
|
|
108
|
+
function TSDocTitle(props) {
|
|
109
|
+
const [{ children }, rest] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, ["children"]);
|
|
110
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
|
|
111
|
+
tag: "title",
|
|
112
|
+
children
|
|
113
|
+
}));
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Create a TSDoc `@domain` tag.
|
|
117
|
+
*/
|
|
118
|
+
function TSDocDomain(props) {
|
|
119
|
+
const [{ children }, rest] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, ["children"]);
|
|
120
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
|
|
121
|
+
tag: "domain",
|
|
122
|
+
children
|
|
123
|
+
}));
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Create a TSDoc `@alias` tag.
|
|
127
|
+
*/
|
|
128
|
+
function TSDocAlias(props) {
|
|
129
|
+
const [{ children }, rest] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, ["children"]);
|
|
130
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
|
|
131
|
+
tag: "alias",
|
|
132
|
+
children
|
|
133
|
+
}));
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Create a TSDoc `@permission` tag.
|
|
137
|
+
*/
|
|
138
|
+
function TSDocPermission(props) {
|
|
139
|
+
const [{ children }, rest] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, ["children"]);
|
|
140
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
|
|
141
|
+
tag: "permission",
|
|
142
|
+
children
|
|
143
|
+
}));
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Create a TSDoc `@defaultValue` tag.
|
|
147
|
+
*/
|
|
148
|
+
function TSDocDefaultValue(props) {
|
|
149
|
+
return [
|
|
150
|
+
"@defaultValue ",
|
|
151
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
152
|
+
get when() {
|
|
153
|
+
return !(0, __stryke_type_checks_is_undefined.isUndefined)(props.value);
|
|
154
|
+
},
|
|
155
|
+
get children() {
|
|
156
|
+
return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
|
|
157
|
+
width: 2,
|
|
158
|
+
get children() {
|
|
159
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Prose, { get children() {
|
|
160
|
+
return require_utilities.stringifyDefaultValue(props.value);
|
|
161
|
+
} });
|
|
162
|
+
}
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
}),
|
|
166
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
|
|
167
|
+
];
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* Create a TSDoc `@remarks` tag.
|
|
171
|
+
*/
|
|
172
|
+
function TSDocRemarks(props) {
|
|
173
|
+
return [
|
|
174
|
+
"@remarks ",
|
|
175
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
176
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.List, {
|
|
177
|
+
hardline: true,
|
|
178
|
+
get children() {
|
|
179
|
+
return (0, __powerlines_plugin_alloy_vendor.childrenArray)(() => props.children);
|
|
180
|
+
}
|
|
181
|
+
})
|
|
182
|
+
];
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Create a TSDoc `@see` tag.
|
|
186
|
+
*/
|
|
187
|
+
function TSDocLink(props) {
|
|
188
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { tag: "see" }));
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Create a TSDoc `@example` tag.
|
|
192
|
+
*/
|
|
193
|
+
function TSDocExample(props) {
|
|
194
|
+
const [{ tsx, fenced = true, language, children }] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, [
|
|
195
|
+
"tsx",
|
|
196
|
+
"fenced",
|
|
197
|
+
"language",
|
|
198
|
+
"children"
|
|
199
|
+
]);
|
|
200
|
+
return [
|
|
201
|
+
"@example ",
|
|
202
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
203
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
204
|
+
when: fenced,
|
|
205
|
+
get children() {
|
|
206
|
+
return [
|
|
207
|
+
"```",
|
|
208
|
+
language || (tsx ? "tsx" : "ts"),
|
|
209
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
|
|
210
|
+
];
|
|
211
|
+
}
|
|
212
|
+
}),
|
|
213
|
+
children,
|
|
214
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
215
|
+
when: fenced,
|
|
216
|
+
get children() {
|
|
217
|
+
return [(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}), "```"];
|
|
218
|
+
}
|
|
219
|
+
})
|
|
220
|
+
];
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Create a TSDoc `@readonly` tag.
|
|
224
|
+
*/
|
|
225
|
+
function TSDocReadonly() {
|
|
226
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "readonly" });
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Create a TSDoc `@internal` tag.
|
|
230
|
+
*/
|
|
231
|
+
function TSDocInternal() {
|
|
232
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "internal" });
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Create a TSDoc `@ignore` tag.
|
|
236
|
+
*/
|
|
237
|
+
function TSDocIgnore() {
|
|
238
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "ignore" });
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* Create a TSDoc `@hidden` tag.
|
|
242
|
+
*/
|
|
243
|
+
function TSDocHidden() {
|
|
244
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "hidden" });
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Generates a TypeScript interface property for the given reflection class.
|
|
248
|
+
*/
|
|
249
|
+
function TSDocAttributesTags(props) {
|
|
250
|
+
const [{ title, alias, permission, domain, readonly, internal, ignore, hidden, defaultValue }] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, [
|
|
251
|
+
"title",
|
|
252
|
+
"alias",
|
|
253
|
+
"permission",
|
|
254
|
+
"domain",
|
|
255
|
+
"readonly",
|
|
256
|
+
"internal",
|
|
257
|
+
"ignore",
|
|
258
|
+
"hidden",
|
|
259
|
+
"defaultValue"
|
|
260
|
+
]);
|
|
261
|
+
return [
|
|
262
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
263
|
+
get when() {
|
|
264
|
+
return (0, __stryke_type_checks_is_set_string.isSetString)(title);
|
|
265
|
+
},
|
|
266
|
+
get children() {
|
|
267
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTitle, { children: title });
|
|
268
|
+
}
|
|
269
|
+
}),
|
|
270
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
271
|
+
get when() {
|
|
272
|
+
return !(0, __stryke_type_checks_is_undefined.isUndefined)(alias) && alias.length > 0;
|
|
273
|
+
},
|
|
274
|
+
get children() {
|
|
275
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.For, {
|
|
276
|
+
each: alias ?? [],
|
|
277
|
+
children: (alias$1) => (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocAlias, { children: alias$1 })
|
|
278
|
+
});
|
|
279
|
+
}
|
|
280
|
+
}),
|
|
281
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
282
|
+
get when() {
|
|
283
|
+
return (0, __stryke_type_checks_is_set_string.isSetString)(domain);
|
|
284
|
+
},
|
|
285
|
+
get children() {
|
|
286
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocDomain, { children: domain });
|
|
287
|
+
}
|
|
288
|
+
}),
|
|
289
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
290
|
+
get when() {
|
|
291
|
+
return !(0, __stryke_type_checks_is_undefined.isUndefined)(permission) && permission.length > 0;
|
|
292
|
+
},
|
|
293
|
+
get children() {
|
|
294
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.For, {
|
|
295
|
+
each: permission ?? [],
|
|
296
|
+
children: (permission$1) => (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocPermission, { children: permission$1 })
|
|
297
|
+
});
|
|
298
|
+
}
|
|
299
|
+
}),
|
|
300
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
301
|
+
when: readonly === true,
|
|
302
|
+
get children() {
|
|
303
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocReadonly, {});
|
|
304
|
+
}
|
|
305
|
+
}),
|
|
306
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
307
|
+
when: internal === true,
|
|
308
|
+
get children() {
|
|
309
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocInternal, {});
|
|
310
|
+
}
|
|
311
|
+
}),
|
|
312
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
313
|
+
when: ignore === true,
|
|
314
|
+
get children() {
|
|
315
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocIgnore, {});
|
|
316
|
+
}
|
|
317
|
+
}),
|
|
318
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
319
|
+
when: hidden === true,
|
|
320
|
+
get children() {
|
|
321
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocHidden, {});
|
|
322
|
+
}
|
|
323
|
+
}),
|
|
324
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
325
|
+
get when() {
|
|
326
|
+
return !(0, __stryke_type_checks_is_undefined.isUndefined)(defaultValue);
|
|
327
|
+
},
|
|
328
|
+
get children() {
|
|
329
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocDefaultValue, { value: defaultValue });
|
|
330
|
+
}
|
|
331
|
+
})
|
|
332
|
+
];
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* Create a TSDoc parameter set off with `@param`.
|
|
336
|
+
*/
|
|
337
|
+
function TSDocParam(props) {
|
|
338
|
+
return [
|
|
339
|
+
"@param ",
|
|
340
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(TSDocParamName, {
|
|
341
|
+
get name() {
|
|
342
|
+
return props.name;
|
|
343
|
+
},
|
|
344
|
+
get optional() {
|
|
345
|
+
return props.optional;
|
|
346
|
+
},
|
|
347
|
+
get defaultValue() {
|
|
348
|
+
return props.defaultValue;
|
|
349
|
+
}
|
|
350
|
+
}),
|
|
351
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(TSDocParamDescription, { get children() {
|
|
352
|
+
return props.children;
|
|
353
|
+
} })
|
|
354
|
+
];
|
|
355
|
+
}
|
|
356
|
+
function TSDocParamName(props) {
|
|
357
|
+
return [
|
|
358
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
359
|
+
get when() {
|
|
360
|
+
return props.optional;
|
|
361
|
+
},
|
|
362
|
+
children: "["
|
|
363
|
+
}),
|
|
364
|
+
(0, __alloy_js_core_jsx_runtime.memo)(() => props.name),
|
|
365
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
366
|
+
get when() {
|
|
367
|
+
return Boolean(props.defaultValue);
|
|
368
|
+
},
|
|
369
|
+
get children() {
|
|
370
|
+
return ["=", (0, __alloy_js_core_jsx_runtime.memo)(() => props.defaultValue)];
|
|
371
|
+
}
|
|
372
|
+
}),
|
|
373
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
374
|
+
get when() {
|
|
375
|
+
return props.optional;
|
|
376
|
+
},
|
|
377
|
+
children: "]"
|
|
378
|
+
})
|
|
379
|
+
];
|
|
380
|
+
}
|
|
381
|
+
function TSDocParamDescription(props) {
|
|
382
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
383
|
+
get when() {
|
|
384
|
+
return Boolean(props.children);
|
|
385
|
+
},
|
|
386
|
+
get children() {
|
|
387
|
+
return [" - ", (0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
|
|
388
|
+
width: 2,
|
|
389
|
+
get children() {
|
|
390
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Prose, { get children() {
|
|
391
|
+
return props.children;
|
|
392
|
+
} });
|
|
393
|
+
}
|
|
394
|
+
})];
|
|
395
|
+
}
|
|
396
|
+
});
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* Create a TSDoc `@returns` tag.
|
|
400
|
+
*/
|
|
401
|
+
function TSDocReturns(props) {
|
|
402
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { tag: "returns" }));
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* Create a TSDoc `@throws` tag.
|
|
406
|
+
*/
|
|
407
|
+
function TSDocThrows(props) {
|
|
408
|
+
return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { tag: "throws" }));
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* Generates a TSDoc `@module` tag for the given module name.
|
|
412
|
+
*/
|
|
413
|
+
function TSDocModule(props) {
|
|
414
|
+
const [{ children, name, prefix }] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, [
|
|
415
|
+
"children",
|
|
416
|
+
"name",
|
|
417
|
+
"prefix"
|
|
418
|
+
]);
|
|
419
|
+
const context = require_core_contexts_context.usePowerlines();
|
|
420
|
+
return [
|
|
421
|
+
"/**",
|
|
422
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
|
|
423
|
+
string: " * ",
|
|
424
|
+
get children() {
|
|
425
|
+
return [
|
|
426
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
427
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
|
|
428
|
+
get when() {
|
|
429
|
+
return Boolean(children);
|
|
430
|
+
},
|
|
431
|
+
get children() {
|
|
432
|
+
return [
|
|
433
|
+
(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.List, {
|
|
434
|
+
hardline: true,
|
|
435
|
+
get children() {
|
|
436
|
+
return (0, __powerlines_plugin_alloy_vendor.childrenArray)(() => children);
|
|
437
|
+
}
|
|
438
|
+
}),
|
|
439
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
440
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
|
|
441
|
+
];
|
|
442
|
+
}
|
|
443
|
+
}),
|
|
444
|
+
"@module ",
|
|
445
|
+
(0, __alloy_js_core_jsx_runtime.memo)(() => prefix || context?.config.output.builtinPrefix),
|
|
446
|
+
":",
|
|
447
|
+
name
|
|
448
|
+
];
|
|
449
|
+
}
|
|
450
|
+
}),
|
|
451
|
+
(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
|
|
452
|
+
` */`
|
|
453
|
+
];
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
//#endregion
|
|
457
|
+
exports.TSDoc = TSDoc;
|
|
458
|
+
exports.TSDocAlias = TSDocAlias;
|
|
459
|
+
exports.TSDocAttributesTags = TSDocAttributesTags;
|
|
460
|
+
exports.TSDocDefaultValue = TSDocDefaultValue;
|
|
461
|
+
exports.TSDocDomain = TSDocDomain;
|
|
462
|
+
exports.TSDocExample = TSDocExample;
|
|
463
|
+
exports.TSDocHidden = TSDocHidden;
|
|
464
|
+
exports.TSDocIgnore = TSDocIgnore;
|
|
465
|
+
exports.TSDocInternal = TSDocInternal;
|
|
466
|
+
exports.TSDocLink = TSDocLink;
|
|
467
|
+
exports.TSDocModule = TSDocModule;
|
|
468
|
+
exports.TSDocParam = TSDocParam;
|
|
469
|
+
exports.TSDocParams = TSDocParams;
|
|
470
|
+
exports.TSDocPermission = TSDocPermission;
|
|
471
|
+
exports.TSDocReadonly = TSDocReadonly;
|
|
472
|
+
exports.TSDocRemarks = TSDocRemarks;
|
|
473
|
+
exports.TSDocReturns = TSDocReturns;
|
|
474
|
+
exports.TSDocTag = TSDocTag;
|
|
475
|
+
exports.TSDocThrows = TSDocThrows;
|
|
476
|
+
exports.TSDocTitle = TSDocTitle;
|
|
@@ -1,4 +1,152 @@
|
|
|
1
|
-
import "../../
|
|
2
|
-
import "
|
|
3
|
-
import {
|
|
1
|
+
import { ComponentProps } from "../../types/components.cjs";
|
|
2
|
+
import { Children } from "@powerlines/plugin-alloy/vendor";
|
|
3
|
+
import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
|
|
4
|
+
|
|
5
|
+
//#region src/typescript/components/tsdoc.d.ts
|
|
6
|
+
interface TSDocProps extends ComponentProps {
|
|
7
|
+
heading?: Children;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Generates a TypeScript interface for the given reflection class.
|
|
11
|
+
*/
|
|
12
|
+
declare function TSDoc(props: TSDocProps): Children;
|
|
13
|
+
interface TSDocTagProps extends ComponentProps {
|
|
14
|
+
tag: string;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Create a TSDoc `@<props.tag>` tag.
|
|
18
|
+
*/
|
|
19
|
+
declare function TSDocTag(props: TSDocTagProps): Children;
|
|
20
|
+
interface TSDocParamsProps {
|
|
21
|
+
parameters: ParameterDescriptor[] | string[];
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* A component that creates a TSDoc block with `@param` tags for each parameter.
|
|
25
|
+
*/
|
|
26
|
+
declare function TSDocParams(props: TSDocParamsProps): Children;
|
|
27
|
+
/**
|
|
28
|
+
* Create a TSDoc `@title` tag.
|
|
29
|
+
*/
|
|
30
|
+
declare function TSDocTitle(props: ComponentProps): Children;
|
|
31
|
+
/**
|
|
32
|
+
* Create a TSDoc `@domain` tag.
|
|
33
|
+
*/
|
|
34
|
+
declare function TSDocDomain(props: ComponentProps): Children;
|
|
35
|
+
/**
|
|
36
|
+
* Create a TSDoc `@alias` tag.
|
|
37
|
+
*/
|
|
38
|
+
declare function TSDocAlias(props: ComponentProps): Children;
|
|
39
|
+
/**
|
|
40
|
+
* Create a TSDoc `@permission` tag.
|
|
41
|
+
*/
|
|
42
|
+
declare function TSDocPermission(props: ComponentProps): Children;
|
|
43
|
+
interface TSDocDefaultValueProps extends ComponentProps {
|
|
44
|
+
value: any;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Create a TSDoc `@defaultValue` tag.
|
|
48
|
+
*/
|
|
49
|
+
declare function TSDocDefaultValue(props: TSDocDefaultValueProps): Children;
|
|
50
|
+
/**
|
|
51
|
+
* Create a TSDoc `@remarks` tag.
|
|
52
|
+
*/
|
|
53
|
+
declare function TSDocRemarks(props: ComponentProps): Children;
|
|
54
|
+
/**
|
|
55
|
+
* Create a TSDoc `@see` tag.
|
|
56
|
+
*/
|
|
57
|
+
declare function TSDocLink(props: ComponentProps): Children;
|
|
58
|
+
interface TSDocExampleProps extends JSDocExampleProps {
|
|
59
|
+
/**
|
|
60
|
+
* Whether the file is a TSX file.
|
|
61
|
+
*
|
|
62
|
+
* @defaultValue false
|
|
63
|
+
*/
|
|
64
|
+
tsx?: boolean;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Create a TSDoc `@example` tag.
|
|
68
|
+
*/
|
|
69
|
+
declare function TSDocExample(props: TSDocExampleProps): Children;
|
|
70
|
+
/**
|
|
71
|
+
* Create a TSDoc `@readonly` tag.
|
|
72
|
+
*/
|
|
73
|
+
declare function TSDocReadonly(): Children;
|
|
74
|
+
/**
|
|
75
|
+
* Create a TSDoc `@internal` tag.
|
|
76
|
+
*/
|
|
77
|
+
declare function TSDocInternal(): Children;
|
|
78
|
+
/**
|
|
79
|
+
* Create a TSDoc `@ignore` tag.
|
|
80
|
+
*/
|
|
81
|
+
declare function TSDocIgnore(): Children;
|
|
82
|
+
/**
|
|
83
|
+
* Create a TSDoc `@hidden` tag.
|
|
84
|
+
*/
|
|
85
|
+
declare function TSDocHidden(): Children;
|
|
86
|
+
interface TSDocAttributesTagsProps {
|
|
87
|
+
title?: string;
|
|
88
|
+
alias?: string[];
|
|
89
|
+
permission?: string[];
|
|
90
|
+
domain?: string;
|
|
91
|
+
readonly?: boolean;
|
|
92
|
+
internal?: boolean;
|
|
93
|
+
ignore?: boolean;
|
|
94
|
+
hidden?: boolean;
|
|
95
|
+
defaultValue?: any;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Generates a TypeScript interface property for the given reflection class.
|
|
99
|
+
*/
|
|
100
|
+
declare function TSDocAttributesTags(props: TSDocAttributesTagsProps): Children;
|
|
101
|
+
interface TSDocParamProps {
|
|
102
|
+
name: Children;
|
|
103
|
+
children?: Children;
|
|
104
|
+
optional?: boolean;
|
|
105
|
+
defaultValue?: Children;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Create a TSDoc parameter set off with `@param`.
|
|
109
|
+
*/
|
|
110
|
+
declare function TSDocParam(props: TSDocParamProps): Children;
|
|
111
|
+
/**
|
|
112
|
+
* Create a TSDoc `@returns` tag.
|
|
113
|
+
*/
|
|
114
|
+
declare function TSDocReturns(props: ComponentProps): Children;
|
|
115
|
+
/**
|
|
116
|
+
* Create a TSDoc `@throws` tag.
|
|
117
|
+
*/
|
|
118
|
+
declare function TSDocThrows(props: ComponentProps): Children;
|
|
119
|
+
interface TSDocModuleProps extends ComponentProps {
|
|
120
|
+
/**
|
|
121
|
+
* the prefix for the builtin module name
|
|
122
|
+
*
|
|
123
|
+
* @defaultValue "storm"
|
|
124
|
+
*/
|
|
125
|
+
prefix?: string;
|
|
126
|
+
/**
|
|
127
|
+
* The name of the module
|
|
128
|
+
*
|
|
129
|
+
* @remarks
|
|
130
|
+
* This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* ```ts
|
|
134
|
+
* import { MyModule } from "storm:my-module";
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
name: Children;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Generates a TSDoc `@module` tag for the given module name.
|
|
141
|
+
*/
|
|
142
|
+
declare function TSDocModule(props: TSDocModuleProps): Children;
|
|
143
|
+
declare type __ΩTSDocProps = any[];
|
|
144
|
+
declare type __ΩTSDocTagProps = any[];
|
|
145
|
+
declare type __ΩTSDocParamsProps = any[];
|
|
146
|
+
declare type __ΩTSDocDefaultValueProps = any[];
|
|
147
|
+
declare type __ΩTSDocExampleProps = any[];
|
|
148
|
+
declare type __ΩTSDocAttributesTagsProps = any[];
|
|
149
|
+
declare type __ΩTSDocParamProps = any[];
|
|
150
|
+
declare type __ΩTSDocModuleProps = any[];
|
|
151
|
+
//#endregion
|
|
4
152
|
export { TSDoc, TSDocAlias, TSDocAttributesTags, TSDocAttributesTagsProps, TSDocDefaultValue, TSDocDefaultValueProps, TSDocDomain, TSDocExample, TSDocExampleProps, TSDocHidden, TSDocIgnore, TSDocInternal, TSDocLink, TSDocModule, TSDocModuleProps, TSDocParam, TSDocParamProps, TSDocParams, TSDocParamsProps, TSDocPermission, TSDocProps, TSDocReadonly, TSDocRemarks, TSDocReturns, TSDocTag, TSDocTagProps, TSDocThrows, TSDocTitle, __ΩTSDocAttributesTagsProps, __ΩTSDocDefaultValueProps, __ΩTSDocExampleProps, __ΩTSDocModuleProps, __ΩTSDocParamProps, __ΩTSDocParamsProps, __ΩTSDocProps, __ΩTSDocTagProps };
|