@powerlines/plugin-alloy 0.25.15 → 0.25.16
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/core/components/output.mjs +1 -2
- package/dist/core/components/single-line-comment.mjs +1 -2
- package/dist/core/components/source-file.mjs +1 -2
- package/dist/core/components/spacing.mjs +1 -2
- package/dist/core/contexts/context.mjs +1 -2
- package/dist/core/contexts/meta.mjs +1 -2
- package/dist/core/contexts/reflection.mjs +1 -2
- package/dist/core/helpers/code.mjs +1 -2
- package/dist/helpers/capnp.mjs +1 -2
- package/dist/helpers/create-builtin.mjs +1 -2
- package/dist/helpers/refkey.mjs +1 -2
- package/dist/helpers/typescript.mjs +1 -2
- package/dist/index.mjs +1 -2
- package/dist/markdown/components/front-matter.mjs +1 -2
- package/dist/markdown/components/markdown-file.mjs +1 -2
- package/dist/markdown/components/markdown-table.mjs +1 -2
- package/dist/markdown/contexts/markdown-table.mjs +1 -2
- package/dist/render.mjs +1 -2
- package/dist/typescript/components/builtin-file.mjs +1 -2
- package/dist/typescript/components/class-declaration.mjs +1 -2
- package/dist/typescript/components/dynamic-import-statement.mjs +1 -2
- package/dist/typescript/components/entry-file.mjs +1 -2
- package/dist/typescript/components/infrastructure-file.mjs +1 -2
- package/dist/typescript/components/interface-declaration.mjs +1 -2
- package/dist/typescript/components/object-declaration.mjs +1 -2
- package/dist/typescript/components/property-name.mjs +1 -2
- package/dist/typescript/components/record-expression.mjs +1 -2
- package/dist/typescript/components/tsdoc-reflection.mjs +1 -2
- package/dist/typescript/components/tsdoc.mjs +1 -2
- package/dist/typescript/components/type-declaration.mjs +1 -2
- package/dist/typescript/components/type-parameters.mjs +1 -2
- package/dist/typescript/components/typescript-file.mjs +1 -2
- package/dist/typescript/contexts/lexical-scope.mjs +1 -2
- package/dist/typescript/contexts/member-scope.mjs +1 -2
- package/dist/typescript/helpers/get-call-signature-props.mjs +1 -2
- package/dist/typescript/helpers/utilities.mjs +1 -2
- package/dist/yaml/components/yaml-file.mjs +1 -2
- package/package.json +18 -18
- package/dist/core/components/index.d.cts +0 -5
- package/dist/core/components/index.d.mts +0 -5
- package/dist/core/components/output.d.cts +0 -25
- package/dist/core/components/output.d.cts.map +0 -1
- package/dist/core/components/output.d.mts +0 -25
- package/dist/core/components/output.d.mts.map +0 -1
- package/dist/core/components/output.mjs.map +0 -1
- package/dist/core/components/single-line-comment.d.cts +0 -23
- package/dist/core/components/single-line-comment.d.cts.map +0 -1
- package/dist/core/components/single-line-comment.d.mts +0 -23
- package/dist/core/components/single-line-comment.d.mts.map +0 -1
- package/dist/core/components/single-line-comment.mjs.map +0 -1
- package/dist/core/components/source-file.d.cts +0 -33
- package/dist/core/components/source-file.d.cts.map +0 -1
- package/dist/core/components/source-file.d.mts +0 -33
- package/dist/core/components/source-file.d.mts.map +0 -1
- package/dist/core/components/source-file.mjs.map +0 -1
- package/dist/core/components/spacing.d.cts +0 -24
- package/dist/core/components/spacing.d.cts.map +0 -1
- package/dist/core/components/spacing.d.mts +0 -24
- package/dist/core/components/spacing.d.mts.map +0 -1
- package/dist/core/components/spacing.mjs.map +0 -1
- package/dist/core/contexts/context.d.cts +0 -30
- package/dist/core/contexts/context.d.cts.map +0 -1
- package/dist/core/contexts/context.d.mts +0 -30
- package/dist/core/contexts/context.d.mts.map +0 -1
- package/dist/core/contexts/context.mjs.map +0 -1
- package/dist/core/contexts/index.d.cts +0 -4
- package/dist/core/contexts/index.d.mts +0 -4
- package/dist/core/contexts/meta.d.cts +0 -48
- package/dist/core/contexts/meta.d.cts.map +0 -1
- package/dist/core/contexts/meta.d.mts +0 -48
- package/dist/core/contexts/meta.d.mts.map +0 -1
- package/dist/core/contexts/meta.mjs.map +0 -1
- package/dist/core/contexts/reflection.d.cts +0 -53
- package/dist/core/contexts/reflection.d.cts.map +0 -1
- package/dist/core/contexts/reflection.d.mts +0 -53
- package/dist/core/contexts/reflection.d.mts.map +0 -1
- package/dist/core/contexts/reflection.mjs.map +0 -1
- package/dist/core/helpers/code.d.cts +0 -30
- package/dist/core/helpers/code.d.cts.map +0 -1
- package/dist/core/helpers/code.d.mts +0 -30
- package/dist/core/helpers/code.d.mts.map +0 -1
- package/dist/core/helpers/code.mjs.map +0 -1
- package/dist/core/helpers/index.d.cts +0 -2
- package/dist/core/helpers/index.d.mts +0 -2
- package/dist/core/index.d.cts +0 -12
- package/dist/core/index.d.mts +0 -12
- package/dist/helpers/capnp.d.cts +0 -88
- package/dist/helpers/capnp.d.cts.map +0 -1
- package/dist/helpers/capnp.d.mts +0 -88
- package/dist/helpers/capnp.d.mts.map +0 -1
- package/dist/helpers/capnp.mjs.map +0 -1
- package/dist/helpers/create-builtin.d.cts +0 -16
- package/dist/helpers/create-builtin.d.cts.map +0 -1
- package/dist/helpers/create-builtin.d.mts +0 -16
- package/dist/helpers/create-builtin.d.mts.map +0 -1
- package/dist/helpers/create-builtin.mjs.map +0 -1
- package/dist/helpers/index.d.cts +0 -5
- package/dist/helpers/index.d.mts +0 -5
- package/dist/helpers/refkey.d.cts +0 -14
- package/dist/helpers/refkey.d.cts.map +0 -1
- package/dist/helpers/refkey.d.mts +0 -14
- package/dist/helpers/refkey.d.mts.map +0 -1
- package/dist/helpers/refkey.mjs.map +0 -1
- package/dist/helpers/typescript.d.cts +0 -26
- package/dist/helpers/typescript.d.cts.map +0 -1
- package/dist/helpers/typescript.d.mts +0 -26
- package/dist/helpers/typescript.d.mts.map +0 -1
- package/dist/helpers/typescript.mjs.map +0 -1
- package/dist/index.d.cts +0 -19
- package/dist/index.d.cts.map +0 -1
- package/dist/index.d.mts +0 -19
- package/dist/index.d.mts.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/markdown/components/front-matter.d.cts +0 -16
- package/dist/markdown/components/front-matter.d.cts.map +0 -1
- package/dist/markdown/components/front-matter.d.mts +0 -16
- package/dist/markdown/components/front-matter.d.mts.map +0 -1
- package/dist/markdown/components/front-matter.mjs.map +0 -1
- package/dist/markdown/components/index.d.cts +0 -4
- package/dist/markdown/components/index.d.mts +0 -4
- package/dist/markdown/components/markdown-file.d.cts +0 -29
- package/dist/markdown/components/markdown-file.d.cts.map +0 -1
- package/dist/markdown/components/markdown-file.d.mts +0 -29
- package/dist/markdown/components/markdown-file.d.mts.map +0 -1
- package/dist/markdown/components/markdown-file.mjs.map +0 -1
- package/dist/markdown/components/markdown-table.d.cts +0 -28
- package/dist/markdown/components/markdown-table.d.cts.map +0 -1
- package/dist/markdown/components/markdown-table.d.mts +0 -28
- package/dist/markdown/components/markdown-table.d.mts.map +0 -1
- package/dist/markdown/components/markdown-table.mjs.map +0 -1
- package/dist/markdown/contexts/index.d.cts +0 -2
- package/dist/markdown/contexts/index.d.mts +0 -2
- package/dist/markdown/contexts/markdown-table.d.cts +0 -38
- package/dist/markdown/contexts/markdown-table.d.cts.map +0 -1
- package/dist/markdown/contexts/markdown-table.d.mts +0 -38
- package/dist/markdown/contexts/markdown-table.d.mts.map +0 -1
- package/dist/markdown/contexts/markdown-table.mjs.map +0 -1
- package/dist/markdown/index.d.cts +0 -7
- package/dist/markdown/index.d.mts +0 -7
- package/dist/render.d.cts +0 -39
- package/dist/render.d.cts.map +0 -1
- package/dist/render.d.mts +0 -39
- package/dist/render.d.mts.map +0 -1
- package/dist/render.mjs.map +0 -1
- package/dist/types/components.d.cts +0 -142
- package/dist/types/components.d.cts.map +0 -1
- package/dist/types/components.d.mts +0 -142
- package/dist/types/components.d.mts.map +0 -1
- package/dist/types/index.d.cts +0 -3
- package/dist/types/index.d.mts +0 -3
- package/dist/types/plugin.d.cts +0 -39
- package/dist/types/plugin.d.cts.map +0 -1
- package/dist/types/plugin.d.mts +0 -39
- package/dist/types/plugin.d.mts.map +0 -1
- package/dist/typescript/components/builtin-file.d.cts +0 -35
- package/dist/typescript/components/builtin-file.d.cts.map +0 -1
- package/dist/typescript/components/builtin-file.d.mts +0 -35
- package/dist/typescript/components/builtin-file.d.mts.map +0 -1
- package/dist/typescript/components/builtin-file.mjs.map +0 -1
- package/dist/typescript/components/class-declaration.d.cts +0 -145
- package/dist/typescript/components/class-declaration.d.cts.map +0 -1
- package/dist/typescript/components/class-declaration.d.mts +0 -145
- package/dist/typescript/components/class-declaration.d.mts.map +0 -1
- package/dist/typescript/components/class-declaration.mjs.map +0 -1
- package/dist/typescript/components/dynamic-import-statement.d.cts +0 -33
- package/dist/typescript/components/dynamic-import-statement.d.cts.map +0 -1
- package/dist/typescript/components/dynamic-import-statement.d.mts +0 -33
- package/dist/typescript/components/dynamic-import-statement.d.mts.map +0 -1
- package/dist/typescript/components/dynamic-import-statement.mjs.map +0 -1
- package/dist/typescript/components/entry-file.d.cts +0 -28
- package/dist/typescript/components/entry-file.d.cts.map +0 -1
- package/dist/typescript/components/entry-file.d.mts +0 -28
- package/dist/typescript/components/entry-file.d.mts.map +0 -1
- package/dist/typescript/components/entry-file.mjs.map +0 -1
- package/dist/typescript/components/index.d.cts +0 -15
- package/dist/typescript/components/index.d.mts +0 -15
- package/dist/typescript/components/infrastructure-file.d.cts +0 -21
- package/dist/typescript/components/infrastructure-file.d.cts.map +0 -1
- package/dist/typescript/components/infrastructure-file.d.mts +0 -21
- package/dist/typescript/components/infrastructure-file.d.mts.map +0 -1
- package/dist/typescript/components/infrastructure-file.mjs.map +0 -1
- package/dist/typescript/components/interface-declaration.d.cts +0 -86
- package/dist/typescript/components/interface-declaration.d.cts.map +0 -1
- package/dist/typescript/components/interface-declaration.d.mts +0 -86
- package/dist/typescript/components/interface-declaration.d.mts.map +0 -1
- package/dist/typescript/components/interface-declaration.mjs.map +0 -1
- package/dist/typescript/components/object-declaration.d.cts +0 -30
- package/dist/typescript/components/object-declaration.d.cts.map +0 -1
- package/dist/typescript/components/object-declaration.d.mts +0 -30
- package/dist/typescript/components/object-declaration.d.mts.map +0 -1
- package/dist/typescript/components/object-declaration.mjs.map +0 -1
- package/dist/typescript/components/property-name.d.cts +0 -24
- package/dist/typescript/components/property-name.d.cts.map +0 -1
- package/dist/typescript/components/property-name.d.mts +0 -24
- package/dist/typescript/components/property-name.d.mts.map +0 -1
- package/dist/typescript/components/property-name.mjs.map +0 -1
- package/dist/typescript/components/record-expression.d.cts +0 -13
- package/dist/typescript/components/record-expression.d.cts.map +0 -1
- package/dist/typescript/components/record-expression.d.mts +0 -13
- package/dist/typescript/components/record-expression.d.mts.map +0 -1
- package/dist/typescript/components/record-expression.mjs.map +0 -1
- package/dist/typescript/components/tsdoc-reflection.d.cts +0 -44
- package/dist/typescript/components/tsdoc-reflection.d.cts.map +0 -1
- package/dist/typescript/components/tsdoc-reflection.d.mts +0 -44
- package/dist/typescript/components/tsdoc-reflection.d.mts.map +0 -1
- package/dist/typescript/components/tsdoc-reflection.mjs.map +0 -1
- package/dist/typescript/components/tsdoc.d.cts +0 -164
- package/dist/typescript/components/tsdoc.d.cts.map +0 -1
- package/dist/typescript/components/tsdoc.d.mts +0 -164
- package/dist/typescript/components/tsdoc.d.mts.map +0 -1
- package/dist/typescript/components/tsdoc.mjs.map +0 -1
- package/dist/typescript/components/type-declaration.d.cts +0 -18
- package/dist/typescript/components/type-declaration.d.cts.map +0 -1
- package/dist/typescript/components/type-declaration.d.mts +0 -18
- package/dist/typescript/components/type-declaration.d.mts.map +0 -1
- package/dist/typescript/components/type-declaration.mjs.map +0 -1
- package/dist/typescript/components/type-parameters.d.cts +0 -24
- package/dist/typescript/components/type-parameters.d.cts.map +0 -1
- package/dist/typescript/components/type-parameters.d.mts +0 -24
- package/dist/typescript/components/type-parameters.d.mts.map +0 -1
- package/dist/typescript/components/type-parameters.mjs.map +0 -1
- package/dist/typescript/components/typescript-file.d.cts +0 -50
- package/dist/typescript/components/typescript-file.d.cts.map +0 -1
- package/dist/typescript/components/typescript-file.d.mts +0 -50
- package/dist/typescript/components/typescript-file.d.mts.map +0 -1
- package/dist/typescript/components/typescript-file.mjs.map +0 -1
- package/dist/typescript/contexts/index.d.cts +0 -2
- package/dist/typescript/contexts/index.d.mts +0 -2
- package/dist/typescript/contexts/lexical-scope.d.cts +0 -17
- package/dist/typescript/contexts/lexical-scope.d.cts.map +0 -1
- package/dist/typescript/contexts/lexical-scope.d.mts +0 -17
- package/dist/typescript/contexts/lexical-scope.d.mts.map +0 -1
- package/dist/typescript/contexts/lexical-scope.mjs.map +0 -1
- package/dist/typescript/contexts/member-scope.d.cts +0 -20
- package/dist/typescript/contexts/member-scope.d.cts.map +0 -1
- package/dist/typescript/contexts/member-scope.d.mts +0 -20
- package/dist/typescript/contexts/member-scope.d.mts.map +0 -1
- package/dist/typescript/contexts/member-scope.mjs.map +0 -1
- package/dist/typescript/helpers/get-call-signature-props.d.cts +0 -15
- package/dist/typescript/helpers/get-call-signature-props.d.cts.map +0 -1
- package/dist/typescript/helpers/get-call-signature-props.d.mts +0 -15
- package/dist/typescript/helpers/get-call-signature-props.d.mts.map +0 -1
- package/dist/typescript/helpers/get-call-signature-props.mjs.map +0 -1
- package/dist/typescript/helpers/index.d.cts +0 -3
- package/dist/typescript/helpers/index.d.mts +0 -3
- package/dist/typescript/helpers/utilities.d.cts +0 -11
- package/dist/typescript/helpers/utilities.d.cts.map +0 -1
- package/dist/typescript/helpers/utilities.d.mts +0 -11
- package/dist/typescript/helpers/utilities.d.mts.map +0 -1
- package/dist/typescript/helpers/utilities.mjs.map +0 -1
- package/dist/typescript/index.d.cts +0 -21
- package/dist/typescript/index.d.mts +0 -21
- package/dist/yaml/components/index.d.cts +0 -2
- package/dist/yaml/components/index.d.mts +0 -2
- package/dist/yaml/components/yaml-file.d.cts +0 -34
- package/dist/yaml/components/yaml-file.d.cts.map +0 -1
- package/dist/yaml/components/yaml-file.d.mts +0 -34
- package/dist/yaml/components/yaml-file.d.mts.map +0 -1
- package/dist/yaml/components/yaml-file.mjs.map +0 -1
- package/dist/yaml/index.d.cts +0 -3
- package/dist/yaml/index.d.mts +0 -3
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
import { TSDocProps } from "./tsdoc.cjs";
|
|
2
|
-
import * as _alloy_js_core11 from "@alloy-js/core";
|
|
3
|
-
import { ReflectionClass, ReflectionMethod, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
4
|
-
|
|
5
|
-
//#region src/typescript/components/tsdoc-reflection.d.ts
|
|
6
|
-
interface TSDocReflectionClassProps<T extends Record<string, any> = Record<string, any>> extends TSDocProps {
|
|
7
|
-
reflection: ReflectionClass<T>;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* Generates a TSDoc documentation block for the given reflection class. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about properties or methods of a class.
|
|
11
|
-
*/
|
|
12
|
-
declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocReflectionClassProps<T>): _alloy_js_core11.Children;
|
|
13
|
-
/**
|
|
14
|
-
* Uses the `useReflectionClass` hook to retrieve the reflection class from the context, and then renders a `TSDocReflectionClass` component with the retrieved reflection class. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection class without having to manually retrieve the reflection class from the context.
|
|
15
|
-
*/
|
|
16
|
-
declare function TSDocContextClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps): _alloy_js_core11.Children;
|
|
17
|
-
interface TSDocReflectionPropertyProps extends TSDocProps {
|
|
18
|
-
reflection: ReflectionProperty;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Generates a TSDoc documentation block for the given reflection property. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about parameters of a method or properties of a class.
|
|
22
|
-
*/
|
|
23
|
-
declare function TSDocReflectionProperty(props: TSDocReflectionPropertyProps): _alloy_js_core11.Children;
|
|
24
|
-
/**
|
|
25
|
-
* Uses the `useReflectionProperty` hook to retrieve the reflection property from the context, and then renders a `TSDocReflectionProperty` component with the retrieved reflection property. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection property without having to manually retrieve the reflection property from the context.
|
|
26
|
-
*/
|
|
27
|
-
declare function TSDocContextProperty(props: TSDocProps): _alloy_js_core11.Children;
|
|
28
|
-
interface TSDocReflectionMethodProps extends TSDocProps {
|
|
29
|
-
reflection: ReflectionMethod;
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
* Generates a TSDoc documentation block for the given reflection method. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. Additionally, this component will render information about the parameters and return type of the method, if available.
|
|
33
|
-
*/
|
|
34
|
-
declare function TSDocReflectionMethod(props: TSDocReflectionMethodProps): _alloy_js_core11.Children;
|
|
35
|
-
/**
|
|
36
|
-
* Uses the `useReflectionMethod` hook to retrieve the reflection method from the context, and then renders a `TSDocReflectionMethod` component with the retrieved reflection method. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection method without having to manually retrieve the reflection method from the context.
|
|
37
|
-
*/
|
|
38
|
-
declare function TSDocContextMethod(props: TSDocProps): _alloy_js_core11.Children;
|
|
39
|
-
declare type __ΩTSDocReflectionClassProps = any[];
|
|
40
|
-
declare type __ΩTSDocReflectionPropertyProps = any[];
|
|
41
|
-
declare type __ΩTSDocReflectionMethodProps = any[];
|
|
42
|
-
//#endregion
|
|
43
|
-
export { TSDocContextClass, TSDocContextMethod, TSDocContextProperty, TSDocReflectionClass, TSDocReflectionClassProps, TSDocReflectionMethod, TSDocReflectionMethodProps, TSDocReflectionProperty, TSDocReflectionPropertyProps, __ΩTSDocReflectionClassProps, __ΩTSDocReflectionMethodProps, __ΩTSDocReflectionPropertyProps };
|
|
44
|
-
//# sourceMappingURL=tsdoc-reflection.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tsdoc-reflection.d.cts","names":[],"sources":["../../../src/typescript/components/tsdoc-reflection.tsx"],"sourcesContent":[],"mappings":";;;;;UAqDiB,oCACL,sBAAsB,6BACxB;cACI,gBAAgB;;AAH9B;;;AAG8B,iBAMd,oBANc,CAAA,UAOlB,MAPkB,CAAA,MAAA,EAAA,GAAA,CAAA,GAOI,MAPJ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAQrB,yBARqB,CAQK,CARL,CAAA,CAAA,EAQI,gBAAA,CAAG,QARP;;;;AAMd,iBAoFA,iBApFoB,CAAA,UAqFxB,MArFwB,CAAA,MAAA,EAAA,GAAA,CAAA,GAqFF,MArFE,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAsF3B,UAtF2B,CAAA,EAsFjB,gBAAA,CAAA,QAtFiB;AACxB,UAkGK,4BAAA,SAAqC,UAlG1C,CAAA;EAAsB,UAAA,EAmGpB,kBAnGoB;;;;;AAmFlB,iBAsBA,uBAAA,CAtBiB,KAAA,EAsBc,4BAtBd,CAAA,EAsB0C,gBAAA,CAAA,QAtB1C;;;;AAEd,iBA8EH,oBAAA,CA9EG,KAAA,EA8EyB,UA9EzB,CAAA,EA8EmC,gBAAA,CAAA,QA9EnC;AAAA,UAwFF,0BAAA,SAAmC,UAxFjC,CAAA;EAaF,UAAA,EA4EH,gBA5EG;AAOjB;AA0DA;AAUA;AAOA;AAoEgB,iBApEA,qBAAA,CAoE0B,KAAU,EApEP,0BAoEO,CAAA,EApEmB,gBAAA,CAAA,QAoEnB;;;;iBAApC,kBAAA,QAA0B,aAAU,gBAAA,CAAA"}
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
import { TSDocProps } from "./tsdoc.mjs";
|
|
2
|
-
import * as _alloy_js_core11 from "@alloy-js/core";
|
|
3
|
-
import { ReflectionClass, ReflectionMethod, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
4
|
-
|
|
5
|
-
//#region src/typescript/components/tsdoc-reflection.d.ts
|
|
6
|
-
interface TSDocReflectionClassProps<T extends Record<string, any> = Record<string, any>> extends TSDocProps {
|
|
7
|
-
reflection: ReflectionClass<T>;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* Generates a TSDoc documentation block for the given reflection class. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about properties or methods of a class.
|
|
11
|
-
*/
|
|
12
|
-
declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocReflectionClassProps<T>): _alloy_js_core11.Children;
|
|
13
|
-
/**
|
|
14
|
-
* Uses the `useReflectionClass` hook to retrieve the reflection class from the context, and then renders a `TSDocReflectionClass` component with the retrieved reflection class. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection class without having to manually retrieve the reflection class from the context.
|
|
15
|
-
*/
|
|
16
|
-
declare function TSDocContextClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps): _alloy_js_core11.Children;
|
|
17
|
-
interface TSDocReflectionPropertyProps extends TSDocProps {
|
|
18
|
-
reflection: ReflectionProperty;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Generates a TSDoc documentation block for the given reflection property. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about parameters of a method or properties of a class.
|
|
22
|
-
*/
|
|
23
|
-
declare function TSDocReflectionProperty(props: TSDocReflectionPropertyProps): _alloy_js_core11.Children;
|
|
24
|
-
/**
|
|
25
|
-
* Uses the `useReflectionProperty` hook to retrieve the reflection property from the context, and then renders a `TSDocReflectionProperty` component with the retrieved reflection property. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection property without having to manually retrieve the reflection property from the context.
|
|
26
|
-
*/
|
|
27
|
-
declare function TSDocContextProperty(props: TSDocProps): _alloy_js_core11.Children;
|
|
28
|
-
interface TSDocReflectionMethodProps extends TSDocProps {
|
|
29
|
-
reflection: ReflectionMethod;
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
* Generates a TSDoc documentation block for the given reflection method. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. Additionally, this component will render information about the parameters and return type of the method, if available.
|
|
33
|
-
*/
|
|
34
|
-
declare function TSDocReflectionMethod(props: TSDocReflectionMethodProps): _alloy_js_core11.Children;
|
|
35
|
-
/**
|
|
36
|
-
* Uses the `useReflectionMethod` hook to retrieve the reflection method from the context, and then renders a `TSDocReflectionMethod` component with the retrieved reflection method. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection method without having to manually retrieve the reflection method from the context.
|
|
37
|
-
*/
|
|
38
|
-
declare function TSDocContextMethod(props: TSDocProps): _alloy_js_core11.Children;
|
|
39
|
-
declare type __ΩTSDocReflectionClassProps = any[];
|
|
40
|
-
declare type __ΩTSDocReflectionPropertyProps = any[];
|
|
41
|
-
declare type __ΩTSDocReflectionMethodProps = any[];
|
|
42
|
-
//#endregion
|
|
43
|
-
export { TSDocContextClass, TSDocContextMethod, TSDocContextProperty, TSDocReflectionClass, TSDocReflectionClassProps, TSDocReflectionMethod, TSDocReflectionMethodProps, TSDocReflectionProperty, TSDocReflectionPropertyProps, __ΩTSDocReflectionClassProps, __ΩTSDocReflectionMethodProps, __ΩTSDocReflectionPropertyProps };
|
|
44
|
-
//# sourceMappingURL=tsdoc-reflection.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tsdoc-reflection.d.mts","names":[],"sources":["../../../src/typescript/components/tsdoc-reflection.tsx"],"sourcesContent":[],"mappings":";;;;;UAqDiB,oCACL,sBAAsB,6BACxB;cACI,gBAAgB;;AAH9B;;;AAG8B,iBAMd,oBANc,CAAA,UAOlB,MAPkB,CAAA,MAAA,EAAA,GAAA,CAAA,GAOI,MAPJ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAQrB,yBARqB,CAQK,CARL,CAAA,CAAA,EAQI,gBAAA,CAAG,QARP;;;;AAMd,iBAoFA,iBApFoB,CAAA,UAqFxB,MArFwB,CAAA,MAAA,EAAA,GAAA,CAAA,GAqFF,MArFE,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAsF3B,UAtF2B,CAAA,EAsFjB,gBAAA,CAAA,QAtFiB;AACxB,UAkGK,4BAAA,SAAqC,UAlG1C,CAAA;EAAsB,UAAA,EAmGpB,kBAnGoB;;;;;AAmFlB,iBAsBA,uBAAA,CAtBiB,KAAA,EAsBc,4BAtBd,CAAA,EAsB0C,gBAAA,CAAA,QAtB1C;;;;AAEd,iBA8EH,oBAAA,CA9EG,KAAA,EA8EyB,UA9EzB,CAAA,EA8EmC,gBAAA,CAAA,QA9EnC;AAAA,UAwFF,0BAAA,SAAmC,UAxFjC,CAAA;EAaF,UAAA,EA4EH,gBA5EG;AAOjB;AA0DA;AAUA;AAOA;AAoEgB,iBApEA,qBAAA,CAoE0B,KAAU,EApEP,0BAoEO,CAAA,EApEmB,gBAAA,CAAA,QAoEnB;;;;iBAApC,kBAAA,QAA0B,aAAU,gBAAA,CAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tsdoc-reflection.mjs","names":["childrenArray","code","computed","For","List","Show","splitProps","ReflectionKind","stringifyType","titleCase","isSetObject","isSetString","isString","isUndefined","Spacing","useReflectionClass","useReflectionMethod","useReflectionProperty","TSDoc","TSDocAttributesTags","TSDocParam","TSDocReturns","TSDocReflectionClass","props","children","heading","reflection","rest","title","getTitle","getName","computedHeading","getDescription","value","alias","getAlias","domain","getDomain","permission","getPermission","readonly","isReadonly","internal","isInternal","ignore","isIgnored","hidden","isHidden","trim","hasAttributes","length","_$createComponent","_$mergeProps","_$memo","when","filter","Boolean","TSDocContextClass","reflectionClass","TSDocReflectionProperty","hasDefault","getDefaultValue","type","defaultValue","TSDocContextProperty","TSDocReflectionMethod","String","undefined","getParameters","each","hardline","ender","_$createIntrinsic","param","name","optional","isOptional","parameter","description","fallback","getReturnType","kind","void","TSDocContextMethod"],"sources":["../../../src/typescript/components/tsdoc-reflection.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n childrenArray,\n code,\n computed,\n For,\n List,\n Show,\n splitProps\n} from \"@alloy-js/core\";\nimport {\n ReflectionClass,\n ReflectionKind,\n ReflectionMethod,\n ReflectionProperty,\n stringifyType\n} from \"@powerlines/deepkit/vendor/type\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport { isSetObject } from \"@stryke/type-checks\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { isString } from \"@stryke/type-checks/is-string\";\nimport { isUndefined } from \"@stryke/type-checks/is-undefined\";\nimport { Spacing } from \"../../core/components/spacing\";\nimport {\n useReflectionClass,\n useReflectionMethod,\n useReflectionProperty\n} from \"../../core/contexts/reflection\";\nimport {\n TSDoc,\n TSDocAttributesTags,\n TSDocParam,\n TSDocProps,\n TSDocReturns\n} from \"./tsdoc\";\n\nexport interface TSDocReflectionClassProps<\n T extends Record<string, any> = Record<string, any>\n> extends TSDocProps {\n reflection: ReflectionClass<T>;\n}\n\n/**\n * Generates a TSDoc documentation block for the given reflection class. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about properties or methods of a class.\n */\nexport function TSDocReflectionClass<\n T extends Record<string, any> = Record<string, any>\n>(props: TSDocReflectionClassProps<T>) {\n const [{ children, heading, reflection }, rest] = splitProps(props, [\n \"heading\",\n \"children\",\n \"reflection\"\n ]);\n\n if (!isSetObject(reflection)) {\n return null;\n }\n\n const title = computed(\n () => reflection.getTitle() || titleCase(reflection.getName())\n );\n const computedHeading = computed(\n () => heading || reflection.getDescription() || title.value\n );\n\n const alias = computed(() => reflection.getAlias());\n const domain = computed(() => reflection.getDomain());\n const permission = computed(() => reflection.getPermission());\n const readonly = computed(() => reflection.isReadonly());\n const internal = computed(() => reflection.isInternal());\n const ignore = computed(() => reflection.isIgnored());\n const hidden = computed(() => reflection.isHidden());\n\n if (\n !computedHeading.value ||\n (isSetString(computedHeading.value) && computedHeading.value.trim() === \"\")\n ) {\n return null;\n }\n\n const hasAttributes = computed(\n () =>\n isSetString(title.value) ||\n (!isUndefined(alias.value) && alias.value.length > 0) ||\n (!isUndefined(permission.value) && permission.value.length > 0) ||\n isSetString(domain.value) ||\n !isUndefined(readonly.value) ||\n !isUndefined(internal.value) ||\n !isUndefined(ignore.value) ||\n !isUndefined(hidden.value)\n );\n\n return (\n <TSDoc\n {...rest}\n heading={\n isSetString(computedHeading.value)\n ? computedHeading.value.trim()\n : computedHeading.value\n }>\n <Show when={hasAttributes.value}>\n <TSDocAttributesTags\n title={title.value}\n alias={alias.value}\n domain={domain.value}\n permission={permission.value}\n readonly={readonly.value}\n internal={internal.value}\n ignore={ignore.value}\n hidden={hidden.value}\n />\n </Show>\n <Show\n when={\n !isUndefined(children) &&\n childrenArray(() => children).filter(Boolean).length > 0\n }>\n <Show when={hasAttributes.value}>\n <Spacing />\n </Show>\n <List>{childrenArray(() => children)}</List>\n </Show>\n </TSDoc>\n );\n}\n\n/**\n * Uses the `useReflectionClass` hook to retrieve the reflection class from the context, and then renders a `TSDocReflectionClass` component with the retrieved reflection class. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection class without having to manually retrieve the reflection class from the context.\n */\nexport function TSDocContextClass<\n T extends Record<string, any> = Record<string, any>\n>(props: TSDocProps) {\n const reflectionClass = useReflectionClass<T>();\n\n return (\n <Show when={isSetObject(reflectionClass.reflection)}>\n <TSDocReflectionClass\n {...props}\n reflection={reflectionClass.reflection}\n />\n </Show>\n );\n}\n\nexport interface TSDocReflectionPropertyProps extends TSDocProps {\n reflection: ReflectionProperty;\n}\n\n/**\n * Generates a TSDoc documentation block for the given reflection property. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about parameters of a method or properties of a class.\n */\nexport function TSDocReflectionProperty(props: TSDocReflectionPropertyProps) {\n const [{ children, reflection }, rest] = splitProps(props, [\n \"children\",\n \"reflection\"\n ]);\n\n if (!isSetObject(reflection)) {\n return null;\n }\n\n const hasAttributes = computed(\n () =>\n isSetString(reflection.getTitle()) ||\n (!isUndefined(reflection.getAlias()) &&\n reflection.getAlias().length > 0) ||\n (!isUndefined(reflection.getPermission()) &&\n reflection.getPermission().length > 0) ||\n isSetString(reflection.getDomain()) ||\n !isUndefined(reflection.isReadonly()) ||\n !isUndefined(reflection.isInternal()) ||\n !isUndefined(reflection.isIgnored()) ||\n !isUndefined(reflection.isHidden()) ||\n (reflection.hasDefault() && !isUndefined(reflection.getDefaultValue()))\n );\n\n return (\n <TSDoc heading={reflection.getDescription()} {...rest}>\n <Show when={hasAttributes.value}>\n <TSDocAttributesTags\n type={reflection}\n title={reflection.getTitle()}\n alias={reflection.getAlias()}\n domain={reflection.getDomain()}\n permission={reflection.getPermission()}\n readonly={reflection.isReadonly()}\n internal={reflection.isInternal()}\n ignore={reflection.isIgnored()}\n hidden={reflection.isHidden()}\n defaultValue={reflection.getDefaultValue()}\n />\n </Show>\n <Show\n when={\n !isUndefined(children) &&\n childrenArray(() => children).filter(Boolean).length > 0\n }>\n <Show when={hasAttributes.value}>\n <Spacing />\n </Show>\n <List>{childrenArray(() => children)}</List>\n </Show>\n </TSDoc>\n );\n}\n\n/**\n * Uses the `useReflectionProperty` hook to retrieve the reflection property from the context, and then renders a `TSDocReflectionProperty` component with the retrieved reflection property. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection property without having to manually retrieve the reflection property from the context.\n */\nexport function TSDocContextProperty(props: TSDocProps) {\n const reflection = useReflectionProperty();\n\n return (\n <Show when={isSetObject(reflection)}>\n <TSDocReflectionProperty {...props} reflection={reflection} />\n </Show>\n );\n}\n\nexport interface TSDocReflectionMethodProps extends TSDocProps {\n reflection: ReflectionMethod;\n}\n\n/**\n * Generates a TSDoc documentation block for the given reflection method. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. Additionally, this component will render information about the parameters and return type of the method, if available.\n */\nexport function TSDocReflectionMethod(props: TSDocReflectionMethodProps) {\n const [{ children, reflection }, rest] = splitProps(props, [\n \"children\",\n \"reflection\"\n ]);\n\n if (!isSetObject(reflection)) {\n return null;\n }\n\n const heading = computed(\n () =>\n reflection.getDescription() ||\n (isString(reflection.getName())\n ? code`${String(reflection.getName())} method definition`\n : undefined)\n );\n\n return (\n <TSDoc heading={heading.value} {...rest}>\n <TSDocAttributesTags\n title={reflection.getTitle()}\n alias={reflection.getAlias()}\n domain={reflection.getDomain()}\n permission={reflection.getPermission()}\n readonly={reflection.isReadonly()}\n internal={reflection.isInternal()}\n ignore={reflection.isIgnored()}\n hidden={reflection.isHidden()}\n />\n <Show\n when={Boolean(children) && childrenArray(() => children).length > 0}>\n <List>{childrenArray(() => children)}</List>\n </Show>\n <Show when={reflection.getParameters().length > 0}>\n <Spacing />\n <For each={reflection.getParameters()} hardline ender={<hbr />}>\n {param => (\n <TSDocParam\n name={param.getName()}\n optional={param.isOptional()}\n defaultValue={\n param.hasDefault() ? param.getDefaultValue() : undefined\n }>\n <Show\n when={Boolean(param.parameter.description)}\n fallback={code`A parameter to provide a ${param.getName()} value to the function.`}>\n {param.parameter.description}\n </Show>\n </TSDocParam>\n )}\n </For>\n </Show>\n <Show when={reflection.getReturnType().kind !== ReflectionKind.void}>\n <Spacing />\n <TSDocReturns>\n {code`The return value of the function, which is of type ${stringifyType(\n reflection.getReturnType()\n )}.`}\n </TSDocReturns>\n </Show>\n </TSDoc>\n );\n}\n\n/**\n * Uses the `useReflectionMethod` hook to retrieve the reflection method from the context, and then renders a `TSDocReflectionMethod` component with the retrieved reflection method. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection method without having to manually retrieve the reflection method from the context.\n */\nexport function TSDocContextMethod(props: TSDocProps) {\n const reflection = useReflectionMethod();\n\n return (\n <Show when={isSetObject(reflection)}>\n <TSDocReflectionMethod {...props} reflection={reflection} />\n </Show>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;SAsOS,4BAAA;;;;;;kBAAA,WAAA;eAAA,0BAAA,UAAA,IAAA,UAAA,WAAA,SAAA;yBAAA,0BAAA,WAAA,gBAAA,IAAA,MAAA;;gBAAA;mCAAA,WAAA,eAAA,CAAA;kBAAA,eAAA,WAAA,YAAA,CAAA;kBAAA,eAAA,WAAA,YAAA,CAAA;gBAAA,eAAA,WAAA,WAAA,CAAA;gBAAA,eAAA,WAAA,UAAA,CAAA;sBAAA;sKAA8B,MAAA,SAAA,iBAAA,OAAA,MAAA,iBAAA,SAAA,uBAAA,SAAA,MAAA,iBAAA,OAAA,MAAA,iBAAA,OAAA;wBAAA,OAAA,WAAA,MAAA;EAAA;;;;2BAc5BwB,MAAAA;IAAAA,IAAAA,OAAAA;AAAAA,YAAAA,cAAAA;;IAAAA,IAAAA,WAAAA;AAAAA,YAAAA,gBAAAA,qBAAAA;MAAAA;;;UAAAA,QAAAA;AAAAA,cAAAA,MAAAA;;MAAAA,IAAAA,SAAAA;AAAAA,cAAAA,OAAAA;;MAAAA,IAAAA,aAAAA;AAAAA,cAAAA,WAAAA;;MAAAA,IAAAA,WAAAA;AAAAA,cAAAA,SAAAA;;MAAAA,IAAAA,WAAAA;AAAAA,cAAAA,SAAAA;;UAAAA;qBAAAA;;MAAAA,IAAAA,SAAAA;AAAAA,cAAAA,OAAAA;;MAAAA,CAAAA;;IAAAA,CAAAA,EAAAA;;;;;;;;;;uCAAQ,EAAA,CAAA;;MAAA,CAAA,EAAA,sBAAA,EAAA,IAAA,WAAA;AAAA,aAAA,oBAAA,SAAA;QAAA,CAAA,CAAA;;IAAA,CAAA,CAAA;;EAAA,CAAA,CAAA;;;;;SAmBO,kBAAA,OAAA;OAAA,kBAAA,oBAAA;;MAAA,OAAA;AAAA,UAAA,YAAA,gBAAA,WAAA;;EAAA,IAAA,WAAA;AAAA,UAAA,sCAAA,WAAA,OAAA,EAAA,iBAAA;AAAA,WAAA;;;;;;;;SACb,wBAAA,OAAA;oBAAA,cAAA,QAAA,WAAA,OAAA;kBAAA,WAAA;uBAAA,2BAAA,WAAA,UAAA,CAAA,iBAAA,WAAA,UAAA,CAAA,eAAA,UAAA,CAAA,SAAA,kBAAA,WAAA,eAAA,CAAA,eAAA,eAAA,CAAA,SAAA,iBAAA,WAAA,WAAA,CAAA,IAAA,CAAA,YAAA;0DAMGE;AAAAA,SAAAA,WAAAA,gBAAAA;IAAAA,EAAAA,MAAAA,EAAAA,IAAAA,WAAAA;AAAAA,SAAAA,CAAAA;OAAAA,OAAAA;AAAAA,WAAAA,cAAAA;;GAAAA,IAAAA,WAAAA;AAAAA,WAAAA,qCAAAA;WAAsB;KAAA,IAAA,QAAA;AAAA,aAAA,WAAA,UAAA;;KAAA,YAAA;AAAA,aAAA,WAAA,UAAA;;KAAA,aAAA;AAAA,aAAA,WAAA,WAAA;;KAAA,iBAAA;AAAA,aAAA,WAAA,eAAA;;KAAA,IAAA,WAAA;AAAA,aAAA,WAAA,YAAA;;KAAA,IAAA,WAAA;AAAA,aAAA,WAAA,YAAA;;KAAA,IAAA,SAAA;AAAA,aAAA,WAAA,WAAA;;KAAA,IAAA,SAAA;AAAA,aAAA,WAAA,UAAA;;KAAA,IAAA,eAAA;AAAA,aAAA,WAAA,iBAAA;;KAAA,CAAA;;GAAA,CAAA,EAAA;;;;;;;2BAI1B;;KAAA,IAAA,WAAA;AAAA,aAAA,gBAAA,SAAE8B,EAAAA,CAAAA;;KAAAA,CAAAA,EAAAA,gBAAAA,MAAAA,EAAAA,IAAAA,WAAAA;AAAAA,YAAAA,oBAAAA,SAAAA;OAAAA,CAAAA,CAAAA;;GAAAA,CAAAA,CAAAA;IAAAA,CAAAA,CAAAA;;;;;;;wBACD,MAAA;EAAA,IAAA,OAAA;AAAA,UAAA,YAAA,WAAA;;EAAA,IAAA,WAAA;AAAA,UAAA,gBAAA,yBAAA,WAAA,OAAA,EAAA,YAAA,CAAA,CAAA;;EAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAAA;IAAA,IAAA,OAAA;AAAA,YAAA,WAAA,eAAA,CAAA,SAAA;;IAAA,IAAA,WAAA;AAAA,YAAA,CAAA,gBAAA,SAAA,EAAA,CAAA,EAAA,gBAAA,KAAA;MAAA,IAAA,OAAA;AAAA,cAAA,0BAAExD;;MAAAA,UAAAA;MAAAA,IAAAA,QAAAA;AAAAA,cAAAA,gBAAAA,OAAAA,EAAAA,CAAAA;;MAAAA,WAAAA,UAAAA,gBAAAA,YAAAA;OAAAA,IAAAA,OAAAA;AAAAA,eAAAA,MAAAA,SAAAA;;OAAAA,IAAAA,WAAAA;AAAAA,eAAAA,MAAAA,YAAAA;;OAAAA,IAAAA,eAAAA;AAAAA,eAAAA,WAAAA,CAAAA,CAAAA,MAAAA,YAAAA,CAAAA,EAAAA,GAAAA,MAAAA,iBAAAA,GAAAA;;OAAAA,IAAAA,WAAAA;AAAAA,eAAAA,gBAAc,MAAA;SAAA,IAAA,OAAA;AAAA,iBAAA,QAAA,MAAA,UAAA,YAAA;;SAAA,IAAA,WAAA;AAAA,iBAAA,IAAA,4BAAA,MAAA,SAAA,CAAA;;SAAA,IAAA,WAAA;AAAA,iBAAA,MAAA,UAAA;;SAAA,CAAA;;OAAA,CAAA;;;;;eAAA;AAAA,YAAA,WAAA,eAAA,CAAA,SAAA,eAAA;;IAAA,IAAA,WAAA;AAAA,YAAA,CAAA,yBAAA,EAAA,CAAA,EAAA,8BAAA,EAAA,IAAA,WAAA;AAAA,iBAAA,sDAAA,yBAAA;QAAA,CAAA,CAAA;;IAAA,CAAA;GAAA;IAAA,CAAA,CAAA;;;;;4BAAMwB,OAAAA;oBAAAA,qBAAAA;;aAAAA;AAAAA,UAAAA,YAAAA,WAAAA;;EAAAA,IAAAA,WAAAA;AAAAA,UAAAA"}
|
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "../../types/components.cjs";
|
|
2
|
-
import { Children } from "@alloy-js/core";
|
|
3
|
-
import { ReflectionKind, ReflectionParameter, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
4
|
-
import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
|
|
5
|
-
|
|
6
|
-
//#region src/typescript/components/tsdoc.d.ts
|
|
7
|
-
interface TSDocProps extends ComponentProps {
|
|
8
|
-
heading?: Children;
|
|
9
|
-
}
|
|
10
|
-
/**
|
|
11
|
-
* Generates a TypeScript interface for the given reflection class.
|
|
12
|
-
*/
|
|
13
|
-
declare function TSDoc(props: TSDocProps): Children;
|
|
14
|
-
interface TSDocTagProps extends ComponentProps {
|
|
15
|
-
tag: string;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Create a TSDoc `@<props.tag>` tag.
|
|
19
|
-
*/
|
|
20
|
-
declare function TSDocTag(props: TSDocTagProps): Children;
|
|
21
|
-
interface TSDocParamsProps {
|
|
22
|
-
parameters: ParameterDescriptor[] | string[];
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* A component that creates a TSDoc block with `@param` tags for each parameter.
|
|
26
|
-
*/
|
|
27
|
-
declare function TSDocParams(props: TSDocParamsProps): Children;
|
|
28
|
-
/**
|
|
29
|
-
* Create a TSDoc `@title` tag.
|
|
30
|
-
*/
|
|
31
|
-
declare function TSDocTitle(props: ComponentProps): Children;
|
|
32
|
-
/**
|
|
33
|
-
* Create a TSDoc `@domain` tag.
|
|
34
|
-
*/
|
|
35
|
-
declare function TSDocDomain(props: ComponentProps): Children;
|
|
36
|
-
/**
|
|
37
|
-
* Create a TSDoc `@alias` tag.
|
|
38
|
-
*/
|
|
39
|
-
declare function TSDocAlias(props: ComponentProps): Children;
|
|
40
|
-
/**
|
|
41
|
-
* Create a TSDoc `@permission` tag.
|
|
42
|
-
*/
|
|
43
|
-
declare function TSDocPermission(props: ComponentProps): Children;
|
|
44
|
-
interface TSDocDefaultValueProps extends ComponentProps {
|
|
45
|
-
type: ReflectionKind | ReflectionProperty | ReflectionParameter;
|
|
46
|
-
defaultValue: any;
|
|
47
|
-
}
|
|
48
|
-
/**
|
|
49
|
-
* Create a TSDoc `@defaultValue` tag.
|
|
50
|
-
*/
|
|
51
|
-
declare function TSDocDefaultValue(props: TSDocDefaultValueProps): Children;
|
|
52
|
-
/**
|
|
53
|
-
* Create a TSDoc `@remarks` tag.
|
|
54
|
-
*/
|
|
55
|
-
declare function TSDocRemarks(props: ComponentProps): Children;
|
|
56
|
-
/**
|
|
57
|
-
* Create a TSDoc `@see` tag.
|
|
58
|
-
*/
|
|
59
|
-
declare function TSDocLink(props: ComponentProps): Children;
|
|
60
|
-
interface TSDocExampleProps extends JSDocExampleProps {
|
|
61
|
-
/**
|
|
62
|
-
* Whether the file is a TSX file.
|
|
63
|
-
*
|
|
64
|
-
* @defaultValue false
|
|
65
|
-
*/
|
|
66
|
-
tsx?: boolean;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Create a TSDoc `@example` tag.
|
|
70
|
-
*/
|
|
71
|
-
declare function TSDocExample(props: TSDocExampleProps): Children;
|
|
72
|
-
/**
|
|
73
|
-
* Create a TSDoc `@readonly` tag.
|
|
74
|
-
*/
|
|
75
|
-
declare function TSDocReadonly(): Children;
|
|
76
|
-
/**
|
|
77
|
-
* Create a TSDoc `@internal` tag.
|
|
78
|
-
*/
|
|
79
|
-
declare function TSDocInternal(): Children;
|
|
80
|
-
/**
|
|
81
|
-
* Create a TSDoc `@ignore` tag.
|
|
82
|
-
*/
|
|
83
|
-
declare function TSDocIgnore(): Children;
|
|
84
|
-
/**
|
|
85
|
-
* Create a TSDoc `@hidden` tag.
|
|
86
|
-
*/
|
|
87
|
-
declare function TSDocHidden(): Children;
|
|
88
|
-
interface TSDocAttributesTagsProps {
|
|
89
|
-
type?: ReflectionKind | ReflectionProperty | ReflectionParameter;
|
|
90
|
-
title?: string;
|
|
91
|
-
alias?: string[];
|
|
92
|
-
permission?: string[];
|
|
93
|
-
domain?: string;
|
|
94
|
-
readonly?: boolean;
|
|
95
|
-
internal?: boolean;
|
|
96
|
-
ignore?: boolean;
|
|
97
|
-
hidden?: boolean;
|
|
98
|
-
defaultValue?: any;
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* Generates a TypeScript interface property for the given reflection class.
|
|
102
|
-
*/
|
|
103
|
-
declare function TSDocAttributesTags(props: TSDocAttributesTagsProps): Children;
|
|
104
|
-
interface TSDocParamProps {
|
|
105
|
-
name: Children;
|
|
106
|
-
children?: Children;
|
|
107
|
-
optional?: boolean;
|
|
108
|
-
defaultValue?: Children;
|
|
109
|
-
}
|
|
110
|
-
/**
|
|
111
|
-
* Create a TSDoc parameter set off with `@param`.
|
|
112
|
-
*/
|
|
113
|
-
declare function TSDocParam(props: TSDocParamProps): Children;
|
|
114
|
-
/**
|
|
115
|
-
* Create a TSDoc `@returns` tag.
|
|
116
|
-
*/
|
|
117
|
-
declare function TSDocReturns(props: ComponentProps): Children;
|
|
118
|
-
/**
|
|
119
|
-
* Create a TSDoc `@throws` tag.
|
|
120
|
-
*/
|
|
121
|
-
declare function TSDocThrows(props: ComponentProps): Children;
|
|
122
|
-
interface TSDocModuleProps extends ComponentProps {
|
|
123
|
-
/**
|
|
124
|
-
* The prefix for the builtin module name
|
|
125
|
-
*
|
|
126
|
-
* @remarks
|
|
127
|
-
* This value is populated from the Powerlines configuration output builtin prefix by default.
|
|
128
|
-
*
|
|
129
|
-
* @example
|
|
130
|
-
* ```ts
|
|
131
|
-
* /**
|
|
132
|
-
* @module powerlines:my-module
|
|
133
|
-
* \/
|
|
134
|
-
* ```
|
|
135
|
-
*/
|
|
136
|
-
prefix?: string;
|
|
137
|
-
/**
|
|
138
|
-
* The name of the module
|
|
139
|
-
*
|
|
140
|
-
* @remarks
|
|
141
|
-
* This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.
|
|
142
|
-
*
|
|
143
|
-
* @example
|
|
144
|
-
* ```ts
|
|
145
|
-
* import { MyModule } from "powerlines:my-module";
|
|
146
|
-
* ```
|
|
147
|
-
*/
|
|
148
|
-
name: Children;
|
|
149
|
-
}
|
|
150
|
-
/**
|
|
151
|
-
* Generates a TSDoc `@module` tag for the given module name.
|
|
152
|
-
*/
|
|
153
|
-
declare function TSDocModule(props: TSDocModuleProps): Children;
|
|
154
|
-
declare type __ΩTSDocProps = any[];
|
|
155
|
-
declare type __ΩTSDocTagProps = any[];
|
|
156
|
-
declare type __ΩTSDocParamsProps = any[];
|
|
157
|
-
declare type __ΩTSDocDefaultValueProps = any[];
|
|
158
|
-
declare type __ΩTSDocExampleProps = any[];
|
|
159
|
-
declare type __ΩTSDocAttributesTagsProps = any[];
|
|
160
|
-
declare type __ΩTSDocParamProps = any[];
|
|
161
|
-
declare type __ΩTSDocModuleProps = any[];
|
|
162
|
-
//#endregion
|
|
163
|
-
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 };
|
|
164
|
-
//# sourceMappingURL=tsdoc.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tsdoc.d.cts","names":[],"sources":["../../../src/typescript/components/tsdoc.tsx"],"sourcesContent":[],"mappings":";;;;;;UAyCiB,UAAA,SAAmB;YACxB;AADZ;AAOA;AA2BA;AAOA;AAgBiB,iBAlDD,KAAA,CAkDiB,KAAA,EAlDJ,UAmDf,CAAA,EAnDyB,QAmDN;AAMjB,UA9BC,aAAA,SAAsB,cA8BY,CAAA;EA2BnC,GAAA,EAAA,MAAA;AAahB;AAaA;AAaA;AAUA;AACQ,iBApGQ,QAAA,CAoGR,KAAA,EApGwB,aAoGxB,CAAA,EApGqC,QAoGrC;AAAiB,UApFR,gBAAA,CAoFQ;EAAqB,UAAA,EAnFhC,mBAmFgC,EAAA,GAAA,MAAA,EAAA;;;AAO9C;AAkBA;AAagB,iBAnHA,WAAA,CAmHiB,KAAA,EAnHE,gBAmHY,CAAA,EAnHI,QAmHJ;AAI/C;AAYA;AA4BA;AAOgB,iBA3IA,UAAA,CA2Ia,KAAA,EA3IK,cA2IL,CAAA,EA3ImB,QA2InB;AAO7B;AAOA;AAIA;AACS,iBAjJO,WAAA,CAiJP,KAAA,EAjJ0B,cAiJ1B,CAAA,EAjJwC,QAiJxC;;;;AAeO,iBAnJA,UAAA,CAmJmB,KAAQ,EAnJT,cAmJS,CAAA,EAnJK,QAmJmB;AA8EnE;;;AAIiB,iBAxND,eAAA,CAwNC,KAAA,EAxNsB,cAwNtB,CAAA,EAxNoC,QAwNpC;AAAQ,UA9MR,sBAAA,SAA+B,cA8MvB,CAAA;EAMT,IAAA,EAnNR,cAmNkB,GAnND,kBAmNS,GAnNY,mBAmNG;EAiDjC,YAAA,EAAA,GAAY;AAO5B;AAIA;AAiCA;;iBAzSgB,iBAAA,QAAyB,yBAAsB;;;;iBAkB/C,YAAA,QAAoB,iBAAc;;;;iBAalC,SAAA,QAAiB,iBAAc;UAI9B,iBAAA,SAA0B;;;;;;;;;;;iBAY3B,YAAA,QAAoB,oBAAiB;;;;iBA4BrC,aAAA,CAAA,GAAa;;;;iBAOb,aAAA,CAAA,GAAa;;;;iBAOb,WAAA,CAAA,GAAW;;;;iBAOX,WAAA,CAAA,GAAW;UAIV,wBAAA;SACR,iBAAiB,qBAAqB;;;;;;;;;;;;;;iBAe/B,mBAAA,QAA2B,2BAAwB;UA8ElD,eAAA;QACT;aACK;;iBAEI;;;;;iBAMD,UAAA,QAAkB,kBAAe;;;;iBAiDjC,YAAA,QAAoB,iBAAc;;;;iBAOlC,WAAA,QAAmB,iBAAc;UAIhC,gBAAA,SAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;QA2BlC;;;;;iBAMQ,WAAA,QAAmB,mBAAgB"}
|
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "../../types/components.mjs";
|
|
2
|
-
import { Children } from "@alloy-js/core";
|
|
3
|
-
import { ReflectionKind, ReflectionParameter, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
4
|
-
import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
|
|
5
|
-
|
|
6
|
-
//#region src/typescript/components/tsdoc.d.ts
|
|
7
|
-
interface TSDocProps extends ComponentProps {
|
|
8
|
-
heading?: Children;
|
|
9
|
-
}
|
|
10
|
-
/**
|
|
11
|
-
* Generates a TypeScript interface for the given reflection class.
|
|
12
|
-
*/
|
|
13
|
-
declare function TSDoc(props: TSDocProps): Children;
|
|
14
|
-
interface TSDocTagProps extends ComponentProps {
|
|
15
|
-
tag: string;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Create a TSDoc `@<props.tag>` tag.
|
|
19
|
-
*/
|
|
20
|
-
declare function TSDocTag(props: TSDocTagProps): Children;
|
|
21
|
-
interface TSDocParamsProps {
|
|
22
|
-
parameters: ParameterDescriptor[] | string[];
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* A component that creates a TSDoc block with `@param` tags for each parameter.
|
|
26
|
-
*/
|
|
27
|
-
declare function TSDocParams(props: TSDocParamsProps): Children;
|
|
28
|
-
/**
|
|
29
|
-
* Create a TSDoc `@title` tag.
|
|
30
|
-
*/
|
|
31
|
-
declare function TSDocTitle(props: ComponentProps): Children;
|
|
32
|
-
/**
|
|
33
|
-
* Create a TSDoc `@domain` tag.
|
|
34
|
-
*/
|
|
35
|
-
declare function TSDocDomain(props: ComponentProps): Children;
|
|
36
|
-
/**
|
|
37
|
-
* Create a TSDoc `@alias` tag.
|
|
38
|
-
*/
|
|
39
|
-
declare function TSDocAlias(props: ComponentProps): Children;
|
|
40
|
-
/**
|
|
41
|
-
* Create a TSDoc `@permission` tag.
|
|
42
|
-
*/
|
|
43
|
-
declare function TSDocPermission(props: ComponentProps): Children;
|
|
44
|
-
interface TSDocDefaultValueProps extends ComponentProps {
|
|
45
|
-
type: ReflectionKind | ReflectionProperty | ReflectionParameter;
|
|
46
|
-
defaultValue: any;
|
|
47
|
-
}
|
|
48
|
-
/**
|
|
49
|
-
* Create a TSDoc `@defaultValue` tag.
|
|
50
|
-
*/
|
|
51
|
-
declare function TSDocDefaultValue(props: TSDocDefaultValueProps): Children;
|
|
52
|
-
/**
|
|
53
|
-
* Create a TSDoc `@remarks` tag.
|
|
54
|
-
*/
|
|
55
|
-
declare function TSDocRemarks(props: ComponentProps): Children;
|
|
56
|
-
/**
|
|
57
|
-
* Create a TSDoc `@see` tag.
|
|
58
|
-
*/
|
|
59
|
-
declare function TSDocLink(props: ComponentProps): Children;
|
|
60
|
-
interface TSDocExampleProps extends JSDocExampleProps {
|
|
61
|
-
/**
|
|
62
|
-
* Whether the file is a TSX file.
|
|
63
|
-
*
|
|
64
|
-
* @defaultValue false
|
|
65
|
-
*/
|
|
66
|
-
tsx?: boolean;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Create a TSDoc `@example` tag.
|
|
70
|
-
*/
|
|
71
|
-
declare function TSDocExample(props: TSDocExampleProps): Children;
|
|
72
|
-
/**
|
|
73
|
-
* Create a TSDoc `@readonly` tag.
|
|
74
|
-
*/
|
|
75
|
-
declare function TSDocReadonly(): Children;
|
|
76
|
-
/**
|
|
77
|
-
* Create a TSDoc `@internal` tag.
|
|
78
|
-
*/
|
|
79
|
-
declare function TSDocInternal(): Children;
|
|
80
|
-
/**
|
|
81
|
-
* Create a TSDoc `@ignore` tag.
|
|
82
|
-
*/
|
|
83
|
-
declare function TSDocIgnore(): Children;
|
|
84
|
-
/**
|
|
85
|
-
* Create a TSDoc `@hidden` tag.
|
|
86
|
-
*/
|
|
87
|
-
declare function TSDocHidden(): Children;
|
|
88
|
-
interface TSDocAttributesTagsProps {
|
|
89
|
-
type?: ReflectionKind | ReflectionProperty | ReflectionParameter;
|
|
90
|
-
title?: string;
|
|
91
|
-
alias?: string[];
|
|
92
|
-
permission?: string[];
|
|
93
|
-
domain?: string;
|
|
94
|
-
readonly?: boolean;
|
|
95
|
-
internal?: boolean;
|
|
96
|
-
ignore?: boolean;
|
|
97
|
-
hidden?: boolean;
|
|
98
|
-
defaultValue?: any;
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* Generates a TypeScript interface property for the given reflection class.
|
|
102
|
-
*/
|
|
103
|
-
declare function TSDocAttributesTags(props: TSDocAttributesTagsProps): Children;
|
|
104
|
-
interface TSDocParamProps {
|
|
105
|
-
name: Children;
|
|
106
|
-
children?: Children;
|
|
107
|
-
optional?: boolean;
|
|
108
|
-
defaultValue?: Children;
|
|
109
|
-
}
|
|
110
|
-
/**
|
|
111
|
-
* Create a TSDoc parameter set off with `@param`.
|
|
112
|
-
*/
|
|
113
|
-
declare function TSDocParam(props: TSDocParamProps): Children;
|
|
114
|
-
/**
|
|
115
|
-
* Create a TSDoc `@returns` tag.
|
|
116
|
-
*/
|
|
117
|
-
declare function TSDocReturns(props: ComponentProps): Children;
|
|
118
|
-
/**
|
|
119
|
-
* Create a TSDoc `@throws` tag.
|
|
120
|
-
*/
|
|
121
|
-
declare function TSDocThrows(props: ComponentProps): Children;
|
|
122
|
-
interface TSDocModuleProps extends ComponentProps {
|
|
123
|
-
/**
|
|
124
|
-
* The prefix for the builtin module name
|
|
125
|
-
*
|
|
126
|
-
* @remarks
|
|
127
|
-
* This value is populated from the Powerlines configuration output builtin prefix by default.
|
|
128
|
-
*
|
|
129
|
-
* @example
|
|
130
|
-
* ```ts
|
|
131
|
-
* /**
|
|
132
|
-
* @module powerlines:my-module
|
|
133
|
-
* \/
|
|
134
|
-
* ```
|
|
135
|
-
*/
|
|
136
|
-
prefix?: string;
|
|
137
|
-
/**
|
|
138
|
-
* The name of the module
|
|
139
|
-
*
|
|
140
|
-
* @remarks
|
|
141
|
-
* This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.
|
|
142
|
-
*
|
|
143
|
-
* @example
|
|
144
|
-
* ```ts
|
|
145
|
-
* import { MyModule } from "powerlines:my-module";
|
|
146
|
-
* ```
|
|
147
|
-
*/
|
|
148
|
-
name: Children;
|
|
149
|
-
}
|
|
150
|
-
/**
|
|
151
|
-
* Generates a TSDoc `@module` tag for the given module name.
|
|
152
|
-
*/
|
|
153
|
-
declare function TSDocModule(props: TSDocModuleProps): Children;
|
|
154
|
-
declare type __ΩTSDocProps = any[];
|
|
155
|
-
declare type __ΩTSDocTagProps = any[];
|
|
156
|
-
declare type __ΩTSDocParamsProps = any[];
|
|
157
|
-
declare type __ΩTSDocDefaultValueProps = any[];
|
|
158
|
-
declare type __ΩTSDocExampleProps = any[];
|
|
159
|
-
declare type __ΩTSDocAttributesTagsProps = any[];
|
|
160
|
-
declare type __ΩTSDocParamProps = any[];
|
|
161
|
-
declare type __ΩTSDocModuleProps = any[];
|
|
162
|
-
//#endregion
|
|
163
|
-
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 };
|
|
164
|
-
//# sourceMappingURL=tsdoc.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tsdoc.d.mts","names":[],"sources":["../../../src/typescript/components/tsdoc.tsx"],"sourcesContent":[],"mappings":";;;;;;UAyCiB,UAAA,SAAmB;YACxB;AADZ;AAOA;AA2BA;AAOA;AAgBiB,iBAlDD,KAAA,CAkDiB,KAAA,EAlDJ,UAmDf,CAAA,EAnDyB,QAmDN;AAMjB,UA9BC,aAAA,SAAsB,cA8BY,CAAA;EA2BnC,GAAA,EAAA,MAAA;AAahB;AAaA;AAaA;AAUA;AACQ,iBApGQ,QAAA,CAoGR,KAAA,EApGwB,aAoGxB,CAAA,EApGqC,QAoGrC;AAAiB,UApFR,gBAAA,CAoFQ;EAAqB,UAAA,EAnFhC,mBAmFgC,EAAA,GAAA,MAAA,EAAA;;;AAO9C;AAkBA;AAagB,iBAnHA,WAAA,CAmHiB,KAAA,EAnHE,gBAmHY,CAAA,EAnHI,QAmHJ;AAI/C;AAYA;AA4BA;AAOgB,iBA3IA,UAAA,CA2Ia,KAAA,EA3IK,cA2IL,CAAA,EA3ImB,QA2InB;AAO7B;AAOA;AAIA;AACS,iBAjJO,WAAA,CAiJP,KAAA,EAjJ0B,cAiJ1B,CAAA,EAjJwC,QAiJxC;;;;AAeO,iBAnJA,UAAA,CAmJmB,KAAQ,EAnJT,cAmJS,CAAA,EAnJK,QAmJmB;AA8EnE;;;AAIiB,iBAxND,eAAA,CAwNC,KAAA,EAxNsB,cAwNtB,CAAA,EAxNoC,QAwNpC;AAAQ,UA9MR,sBAAA,SAA+B,cA8MvB,CAAA;EAMT,IAAA,EAnNR,cAmNkB,GAnND,kBAmNS,GAnNY,mBAmNG;EAiDjC,YAAA,EAAA,GAAY;AAO5B;AAIA;AAiCA;;iBAzSgB,iBAAA,QAAyB,yBAAsB;;;;iBAkB/C,YAAA,QAAoB,iBAAc;;;;iBAalC,SAAA,QAAiB,iBAAc;UAI9B,iBAAA,SAA0B;;;;;;;;;;;iBAY3B,YAAA,QAAoB,oBAAiB;;;;iBA4BrC,aAAA,CAAA,GAAa;;;;iBAOb,aAAA,CAAA,GAAa;;;;iBAOb,WAAA,CAAA,GAAW;;;;iBAOX,WAAA,CAAA,GAAW;UAIV,wBAAA;SACR,iBAAiB,qBAAqB;;;;;;;;;;;;;;iBAe/B,mBAAA,QAA2B,2BAAwB;UA8ElD,eAAA;QACT;aACK;;iBAEI;;;;;iBAMD,UAAA,QAAkB,kBAAe;;;;iBAiDjC,YAAA,QAAoB,iBAAc;;;;iBAOlC,WAAA,QAAmB,iBAAc;UAIhC,gBAAA,SAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;QA2BlC;;;;;iBAMQ,WAAA,QAAmB,mBAAgB"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tsdoc.mjs","names":["childrenArray","computed","For","List","Prose","Show","splitProps","stringifyDefaultValue","isSetString","isUndefined","Spacing","usePowerlinesSafe","TSDoc","props","children","heading","_$createIntrinsic","string","_$createComponent","when","_$memo","filter","Boolean","length","TSDocTag","tag","width","TSDocParams","parameters","normalizeParametersForDoc","each","param","TSDocParam","name","optional","doc","some","p","TSDocTitle","rest","_$mergeProps","TSDocDomain","TSDocAlias","TSDocPermission","TSDocDefaultValue","type","defaultValue","TSDocRemarks","hardline","TSDocLink","TSDocExample","tsx","fenced","language","TSDocReadonly","TSDocInternal","TSDocIgnore","TSDocHidden","TSDocAttributesTags","alias","permission","readonly","internal","ignore","hidden","title","trim","domain","value","a","TSDocParamName","TSDocParamDescription","TSDocReturns","TSDocThrows","TSDocModule","prefix","context","config","framework"],"sources":["../../../src/typescript/components/tsdoc.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n Children,\n childrenArray,\n computed,\n For,\n List,\n Prose,\n Show,\n splitProps\n} from \"@alloy-js/core\";\nimport { JSDocExampleProps, ParameterDescriptor } from \"@alloy-js/typescript\";\nimport { stringifyDefaultValue } from \"@powerlines/deepkit/utilities\";\nimport {\n ReflectionKind,\n ReflectionParameter,\n ReflectionProperty\n} from \"@powerlines/deepkit/vendor/type\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { isUndefined } from \"@stryke/type-checks/is-undefined\";\nimport { Spacing } from \"../../core/components/spacing\";\nimport { usePowerlinesSafe } from \"../../core/contexts/context\";\nimport { ComponentProps } from \"../../types/components\";\n\nexport interface TSDocProps extends ComponentProps {\n heading?: Children;\n}\n\n/**\n * Generates a TypeScript interface for the given reflection class.\n */\nexport function TSDoc(props: TSDocProps) {\n const [{ children, heading }] = splitProps(props, [\"children\", \"heading\"]);\n\n return (\n <>\n /**\n <align string=\" * \">\n <hbr />\n <Show when={!isUndefined(heading)}>{heading}</Show>\n <Show\n when={\n !isUndefined(children) &&\n childrenArray(() => children).filter(Boolean).length > 0\n }>\n <Show when={!isUndefined(heading)}>\n <Spacing />\n </Show>\n <List>{childrenArray(() => children)}</List>\n </Show>\n </align>\n <hbr />\n {`*/`}\n <hbr />\n </>\n );\n}\n\nexport interface TSDocTagProps extends ComponentProps {\n tag: string;\n}\n\n/**\n * Create a TSDoc `@<props.tag>` tag.\n */\nexport function TSDocTag(props: TSDocTagProps) {\n const [{ children, tag }] = splitProps(props, [\"children\", \"tag\"]);\n\n return (\n <>\n {`@${tag} `}\n <Show when={Boolean(children)}>\n <align width={2}>\n <Prose>{children}</Prose>\n </align>\n </Show>\n <sbr />\n </>\n );\n}\n\nexport interface TSDocParamsProps {\n parameters: ParameterDescriptor[] | string[];\n}\n\n/**\n * A component that creates a TSDoc block with `@param` tags for each parameter.\n */\nexport function TSDocParams(props: TSDocParamsProps) {\n const parameters = normalizeParametersForDoc(props.parameters);\n\n return (\n <For each={parameters}>\n {param => (\n <TSDocParam name={param.name} optional={param.optional}>\n {param.doc}\n </TSDocParam>\n )}\n </For>\n );\n}\n\nfunction normalizeParametersForDoc(\n parameters: ParameterDescriptor[] | string[]\n): ParameterDescriptor[] {\n if (parameters.some(p => typeof p === \"string\")) {\n return [];\n }\n\n return parameters as ParameterDescriptor[];\n}\n\n/**\n * Create a TSDoc `@title` tag.\n */\nexport function TSDocTitle(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"title\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@domain` tag.\n */\nexport function TSDocDomain(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"domain\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@alias` tag.\n */\nexport function TSDocAlias(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"alias\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@permission` tag.\n */\nexport function TSDocPermission(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"permission\">\n {children}\n </TSDocTag>\n );\n}\n\nexport interface TSDocDefaultValueProps extends ComponentProps {\n type: ReflectionKind | ReflectionProperty | ReflectionParameter;\n defaultValue: any;\n}\n\n/**\n * Create a TSDoc `@defaultValue` tag.\n */\nexport function TSDocDefaultValue(props: TSDocDefaultValueProps) {\n const [{ type, defaultValue }] = splitProps(props, [\"type\", \"defaultValue\"]);\n\n return (\n <>\n {\"@defaultValue \"}\n <Show when={!isUndefined(defaultValue)}>\n <align width={2}>\n <Prose>{stringifyDefaultValue(type, defaultValue)}</Prose>\n </align>\n </Show>\n </>\n );\n}\n\n/**\n * Create a TSDoc `@remarks` tag.\n */\nexport function TSDocRemarks(props: ComponentProps) {\n return (\n <>\n {\"@remarks \"}\n <hbr />\n <List hardline={true}>{childrenArray(() => props.children)}</List>\n </>\n );\n}\n\n/**\n * Create a TSDoc `@see` tag.\n */\nexport function TSDocLink(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"see\" />;\n}\n\nexport interface TSDocExampleProps extends JSDocExampleProps {\n /**\n * Whether the file is a TSX file.\n *\n * @defaultValue false\n */\n tsx?: boolean;\n}\n\n/**\n * Create a TSDoc `@example` tag.\n */\nexport function TSDocExample(props: TSDocExampleProps) {\n const [{ tsx, fenced = true, language, children }] = splitProps(props, [\n \"tsx\",\n \"fenced\",\n \"language\",\n \"children\"\n ]);\n\n return (\n <>\n {\"@example \"}\n <hbr />\n <Show when={fenced}>\n ```{language || (tsx ? \"tsx\" : \"ts\")}\n <hbr />\n </Show>\n {children}\n <Show when={fenced}>\n <hbr />\n ```\n </Show>\n </>\n );\n}\n\n/**\n * Create a TSDoc `@readonly` tag.\n */\nexport function TSDocReadonly() {\n return <TSDocTag tag=\"readonly\" />;\n}\n\n/**\n * Create a TSDoc `@internal` tag.\n */\nexport function TSDocInternal() {\n return <TSDocTag tag=\"internal\" />;\n}\n\n/**\n * Create a TSDoc `@ignore` tag.\n */\nexport function TSDocIgnore() {\n return <TSDocTag tag=\"ignore\" />;\n}\n\n/**\n * Create a TSDoc `@hidden` tag.\n */\nexport function TSDocHidden() {\n return <TSDocTag tag=\"hidden\" />;\n}\n\nexport interface TSDocAttributesTagsProps {\n type?: ReflectionKind | ReflectionProperty | ReflectionParameter;\n title?: string;\n alias?: string[];\n permission?: string[];\n domain?: string;\n readonly?: boolean;\n internal?: boolean;\n ignore?: boolean;\n hidden?: boolean;\n defaultValue?: any;\n}\n\n/**\n * Generates a TypeScript interface property for the given reflection class.\n */\nexport function TSDocAttributesTags(props: TSDocAttributesTagsProps) {\n const [\n {\n type,\n alias,\n permission,\n readonly,\n internal,\n ignore,\n hidden,\n defaultValue\n }\n ] = splitProps(props, [\n \"type\",\n \"alias\",\n \"permission\",\n \"readonly\",\n \"internal\",\n \"ignore\",\n \"hidden\",\n \"defaultValue\"\n ]);\n\n const title = computed(() => props.title?.trim() || \"\");\n const domain = computed(() => props.domain?.trim() || \"\");\n\n return (\n <>\n <Show when={isSetString(title.value)}>\n <TSDocTitle>{title.value}</TSDocTitle>\n </Show>\n <Show\n when={\n !isUndefined(alias) &&\n alias.length > 0 &&\n alias.some(a => isSetString(a?.trim()))\n }>\n <For each={alias?.filter(a => isSetString(a?.trim())) ?? []}>\n {alias => <TSDocAlias>{alias}</TSDocAlias>}\n </For>\n </Show>\n <Show when={isSetString(domain.value)}>\n <TSDocDomain>{domain.value}</TSDocDomain>\n </Show>\n <Show\n when={\n !isUndefined(permission) &&\n permission.length > 0 &&\n permission.some(p => isSetString(p?.trim()))\n }>\n <For each={permission?.filter(p => isSetString(p?.trim())) ?? []}>\n {permission => <TSDocPermission>{permission}</TSDocPermission>}\n </For>\n </Show>\n <Show when={readonly === true}>\n <TSDocReadonly />\n </Show>\n <Show when={internal === true}>\n <TSDocInternal />\n </Show>\n <Show when={ignore === true}>\n <TSDocIgnore />\n </Show>\n <Show when={hidden === true}>\n <TSDocHidden />\n </Show>\n <Show when={!isUndefined(type) && !isUndefined(defaultValue)}>\n <TSDocDefaultValue\n type={\n type as ReflectionKind | ReflectionProperty | ReflectionParameter\n }\n defaultValue={defaultValue}\n />\n </Show>\n </>\n );\n}\n\nexport interface TSDocParamProps {\n name: Children;\n children?: Children;\n optional?: boolean;\n defaultValue?: Children;\n}\n\n/**\n * Create a TSDoc parameter set off with `@param`.\n */\nexport function TSDocParam(props: TSDocParamProps) {\n return (\n <>\n {\"@param \"}\n <TSDocParamName\n name={props.name}\n optional={props.optional}\n defaultValue={props.defaultValue}\n />\n <TSDocParamDescription children={props.children} />\n </>\n );\n}\n\ninterface TSDocParamNameProps {\n name: Children;\n optional?: boolean;\n defaultValue?: Children;\n}\n\nfunction TSDocParamName(props: TSDocParamNameProps) {\n return (\n <>\n <Show when={props.optional}>{\"[\"}</Show>\n {props.name}\n <Show when={Boolean(props.defaultValue)}>={props.defaultValue}</Show>\n <Show when={props.optional}>{\"]\"}</Show>\n </>\n );\n}\n\ninterface TSDocParamDescriptionProps {\n children?: Children;\n}\n\nfunction TSDocParamDescription(props: TSDocParamDescriptionProps) {\n return (\n <Show when={Boolean(props.children)}>\n {\" - \"}\n <align width={2}>\n <Prose>{props.children}</Prose>\n </align>\n </Show>\n );\n}\n\n/**\n * Create a TSDoc `@returns` tag.\n */\nexport function TSDocReturns(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"returns\" />;\n}\n\n/**\n * Create a TSDoc `@throws` tag.\n */\nexport function TSDocThrows(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"throws\" />;\n}\n\nexport interface TSDocModuleProps extends ComponentProps {\n /**\n * The prefix for the builtin module name\n *\n * @remarks\n * This value is populated from the Powerlines configuration output builtin prefix by default.\n *\n * @example\n * ```ts\n * /**\n * @module powerlines:my-module\n * \\/\n * ```\n */\n prefix?: string;\n\n /**\n * The name of the module\n *\n * @remarks\n * This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.\n *\n * @example\n * ```ts\n * import { MyModule } from \"powerlines:my-module\";\n * ```\n */\n name: Children;\n}\n\n/**\n * Generates a TSDoc `@module` tag for the given module name.\n */\nexport function TSDocModule(props: TSDocModuleProps) {\n const [{ children, name, prefix }] = splitProps(props, [\n \"children\",\n \"name\",\n \"prefix\"\n ]);\n\n const context = usePowerlinesSafe();\n\n return (\n <>\n /**\n <align string=\" * \">\n <hbr />\n <Show when={Boolean(children)}>\n <List hardline={true}>{childrenArray(() => children)}</List>\n <Spacing />\n </Show>\n {\"@module \"}\n {prefix || context?.config?.framework || \"powerlines\"}:{name}\n </align>\n <hbr />\n {` */`}\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiIA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;SAeA,SAAA,OAAA;OAAA,CAAA,EAAA,UAAA,SAAA,WAAA,OAAA,CAAA,YAAA,MAAA,CAAA;AAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;wBAgCe,KAAA;EAAA;EAAA,WAAA,UAAA;;;;;;;;;;;;;SAc+D,0BAAA;KAKlC,WAAA,MAAA,MAAA,OAAA,MAAA,SAAA,CAAA,QAAA,EAAA;;;;;;SAO5C,WAAA,OAAA;CAAA,MAAA,CAAA,EAAA,YAAA,QAAA,WAAA,OAAA,CAAA,WAAA,CAAA;wBAKoD,UAAA,WAAA,MAAA;EAAA,KAAA;EAAA;EAAA,CAAA,CAAA;;;;;SAQpD,YAAA,OAAA;CAAA,MAAA,CAAA,EAAA,YAAA,QAAA,WAAA,OAAA,CAAA,WAAA,CAAA;wBAKiD,UAAA,WAAA,MAAA;EAAA,KAAA;EAAA;EAAA,CAAA,CAAA;;;;;SAgBjD,WAAA,OAAA;CAAA,MAAA,CAAA,EAAA,YAAA,QAAA,WAAA,OAAA,CAAA,WAAA,CAAA;wBACyCc,UAAAA,WAAAA,MAAAA;EAAAA,KAAAA;EAAAA;EAAAA,CAAAA,CAAAA;;;;;SAyBzC,gBAAA,OAAA;CAAA,MAAA,CAAA,EAAA,YAAA,QAAA,WAAA,OAAA,CAAA,WAAA,CAAA;kCACA,WAAA,MAAA;EAAA,KAAA;EAAA;EAAA,CAAA,CAAA;;;;;;CAmBA,MAAA,CAAA,EAAA,MAAA,kBAAA,WAAA,OAAA,CAAA,QAAA,eAAA,CAAA;2CACA,MAAA;EAAA,IAAA,OAAA;AAAA,UAAA,CAAA,YAAA,aAAA;;EAAA,IAAA,WAAA;AAAA,UAAA,gBAAA,SAAA;IAEA,OAAA;IAAA,IAAA,WAAA;AAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoFoB;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAsBpB,EAAA,KAAA,YAAA,CAAA;;;;;;;;;;;SAOcD,cAAAA;wBACE,UAAA,EAAA,KAAA,UAAA,CAAA;;;;;;;;;;;SAmB6BC,oBAAAA,OAAAA;OAAAA,SAAAA,OAAAA,YAAAA,UAAA,UAAA,QAAA,QAAA,6BAAA,OAAA;;;;EAAA;EAAA;EAAA;;;;;;;wBAcxB;GAAA,IAAA,OAAA;AAAA,WAAA,YAAA,MAAA,MAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,YAAA,EAAA,IAAA,WAAA;AAAA,YAAA,MAAA;OAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,WAAA,CAAA,EAAA,CAAA,YAAA,MAAA,IAAA,MAAA,SAAA,GAAA,EAAA,IAAA,MAAA,MAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBACP,KAAA;KAAA,IAAA,OAAA;AAAA,aAAA,OAAA,QAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA,IAAA,EAAA;;KAAA,WAAA,YAAA,gBAAA,YAAA,EAAA,UAAA,SAAA,CAAA;KAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,YAAA,OAAA,MAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,aAAA,EAAA,IAAA,WAAA;AAAA,YAAA,OAAA;OAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,WAAA,CAAA,EAAA,CAAA,YAAA;;;;;;;iDAUZI,iBAAAA,EAAAA,UAAAA,cAAAA,CAAAA;KAAAA,CAAAA;;GAAAA,CAAAA;EAAAA,gBAAAA,MAAAA;GAAAA,MAAAA,aAAAA;GAAAA,IAAAA,WAAAA;AAAAA,WAAAA,gBAAAA,eAAAA,EAAAA,CAAAA;;GAAAA,CAAAA;EAAAA,sBAA+B;GAAA,MAAA,aAAA;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,eAAA,EAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,MAAA,WAAA;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,aAAA,EAAA,CAAA;;GAAA,CAAA;EAAA;;;;;;kBAOA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,WAAA,CAAA,CAAA,CAAA,YAAA,KAAA,CAAA,EAAA,IAAA,CAAA,YAAA,aAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,mBAAA;KAAA;KAAA;KAAA,CAAA;;GAAA,CAAA;EAAA;;;;;SAqCd,WAAA,OAAA;AAAA,QAAA;EAAA;EAAA,gBAAA,gBAAA;GAAA,IAAA,OAAA;AAAA,WAAA,MAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,MAAA;;GAAA,IAAA,eAAA;AAAA,WAAA,MAAA;;GAAA,CAAA;EAAA,uCAAA,EAAA,IAAA,WAAA;AAAA,UAAA,MAAA;KAAA,CAAA;EAAA"}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import * as _alloy_js_core10 from "@alloy-js/core";
|
|
2
|
-
import { CommonDeclarationProps, TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
3
|
-
|
|
4
|
-
//#region src/typescript/components/type-declaration.d.ts
|
|
5
|
-
interface TypeDeclarationProps extends CommonDeclarationProps {
|
|
6
|
-
/**
|
|
7
|
-
* The generic type parameters of the interface.
|
|
8
|
-
*/
|
|
9
|
-
typeParameters?: TypeParameterDescriptor[] | string[];
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Renders a TypeScript type declaration, including its name, optional TSDoc comment, and generic type parameters.
|
|
13
|
-
*/
|
|
14
|
-
declare const TypeDeclaration: _alloy_js_core10.Component<TypeDeclarationProps>;
|
|
15
|
-
declare type __ΩTypeDeclarationProps = any[];
|
|
16
|
-
//#endregion
|
|
17
|
-
export { TypeDeclaration, TypeDeclarationProps, __ΩTypeDeclarationProps };
|
|
18
|
-
//# sourceMappingURL=type-declaration.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"type-declaration.d.cts","names":[],"sources":["../../../src/typescript/components/type-declaration.tsx"],"sourcesContent":[],"mappings":";;;;UA4BiB,oBAAA,SAA6B;;;AAA9C;EAUa,cAAA,CAAA,EANM,uBAMS,EAAA,GAAA,MAAA,EAAA;;;;;cAAf,iBAAe,gBAAA,CAAA,UAAA"}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import * as _alloy_js_core10 from "@alloy-js/core";
|
|
2
|
-
import { CommonDeclarationProps, TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
3
|
-
|
|
4
|
-
//#region src/typescript/components/type-declaration.d.ts
|
|
5
|
-
interface TypeDeclarationProps extends CommonDeclarationProps {
|
|
6
|
-
/**
|
|
7
|
-
* The generic type parameters of the interface.
|
|
8
|
-
*/
|
|
9
|
-
typeParameters?: TypeParameterDescriptor[] | string[];
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Renders a TypeScript type declaration, including its name, optional TSDoc comment, and generic type parameters.
|
|
13
|
-
*/
|
|
14
|
-
declare const TypeDeclaration: _alloy_js_core10.Component<TypeDeclarationProps>;
|
|
15
|
-
declare type __ΩTypeDeclarationProps = any[];
|
|
16
|
-
//#endregion
|
|
17
|
-
export { TypeDeclaration, TypeDeclarationProps, __ΩTypeDeclarationProps };
|
|
18
|
-
//# sourceMappingURL=type-declaration.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"type-declaration.d.mts","names":[],"sources":["../../../src/typescript/components/type-declaration.tsx"],"sourcesContent":[],"mappings":";;;;UA4BiB,oBAAA,SAA6B;;;AAA9C;EAUa,cAAA,CAAA,EANM,uBAMS,EAAA,GAAA,MAAA,EAAA;;;;;cAAf,iBAAe,gBAAA,CAAA,UAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"type-declaration.mjs","names":["Name","Show","Declaration","ensureTypeRefContext","TSDoc","TypeParameters","TypeDeclaration","props","children","doc","typeParameters","rest","_$createComponent","when","Boolean","heading","_$mergeProps","kind","nameKind","_$memo","parameters"],"sources":["../../../src/typescript/components/type-declaration.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { Name, Show } from \"@alloy-js/core\";\nimport {\n CommonDeclarationProps,\n Declaration,\n ensureTypeRefContext,\n TypeParameterDescriptor\n} from \"@alloy-js/typescript\";\nimport { TSDoc } from \"./tsdoc\";\nimport { TypeParameters } from \"./type-parameters\";\n\nexport interface TypeDeclarationProps extends CommonDeclarationProps {\n /**\n * The generic type parameters of the interface.\n */\n typeParameters?: TypeParameterDescriptor[] | string[];\n}\n\n/**\n * Renders a TypeScript type declaration, including its name, optional TSDoc comment, and generic type parameters.\n */\nexport const TypeDeclaration = ensureTypeRefContext(function TypeDeclaration(\n props: TypeDeclarationProps\n) {\n const { children, doc, typeParameters, ...rest } = props;\n\n return (\n <>\n <Show when={Boolean(doc)}>\n <TSDoc heading={doc} />\n </Show>\n <Declaration {...rest} kind=\"type\" nameKind=\"type\">\n type <Name />\n {typeParameters && (\n <TypeParameters parameters={typeParameters} />\n )} = {children};\n </Declaration>\n </>\n );\n});\n"],"mappings":""}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { Children } from "@alloy-js/core";
|
|
2
|
-
import { TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
3
|
-
|
|
4
|
-
//#region src/typescript/components/type-parameters.d.ts
|
|
5
|
-
/** Props for type parameters */
|
|
6
|
-
interface TypeParametersProps {
|
|
7
|
-
/** Parameters */
|
|
8
|
-
parameters?: TypeParameterDescriptor[] | string[];
|
|
9
|
-
/** Jsx Children */
|
|
10
|
-
children?: Children;
|
|
11
|
-
}
|
|
12
|
-
/**
|
|
13
|
-
* Represent type parameters
|
|
14
|
-
*
|
|
15
|
-
* @example
|
|
16
|
-
* ```ts
|
|
17
|
-
* <A, B extends string>
|
|
18
|
-
* ```
|
|
19
|
-
*/
|
|
20
|
-
declare function TypeParameters(props: TypeParametersProps): Children;
|
|
21
|
-
declare type __ΩTypeParametersProps = any[];
|
|
22
|
-
//#endregion
|
|
23
|
-
export { TypeParameters, TypeParametersProps, __ΩTypeParametersProps };
|
|
24
|
-
//# sourceMappingURL=type-parameters.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"type-parameters.d.cts","names":[],"sources":["../../../src/typescript/components/type-parameters.tsx"],"sourcesContent":[],"mappings":";;;;;UAsBiB,mBAAA;EAAA;EAyCD,UAAA,CAAA,EAvCD,uBAuCuB,EAAA,GAAA,MAAA,EAAA;;aArCzB;;;;;;;;;;iBAqCG,cAAA,QAAsB,sBAAmB"}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { Children } from "@alloy-js/core";
|
|
2
|
-
import { TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
3
|
-
|
|
4
|
-
//#region src/typescript/components/type-parameters.d.ts
|
|
5
|
-
/** Props for type parameters */
|
|
6
|
-
interface TypeParametersProps {
|
|
7
|
-
/** Parameters */
|
|
8
|
-
parameters?: TypeParameterDescriptor[] | string[];
|
|
9
|
-
/** Jsx Children */
|
|
10
|
-
children?: Children;
|
|
11
|
-
}
|
|
12
|
-
/**
|
|
13
|
-
* Represent type parameters
|
|
14
|
-
*
|
|
15
|
-
* @example
|
|
16
|
-
* ```ts
|
|
17
|
-
* <A, B extends string>
|
|
18
|
-
* ```
|
|
19
|
-
*/
|
|
20
|
-
declare function TypeParameters(props: TypeParametersProps): Children;
|
|
21
|
-
declare type __ΩTypeParametersProps = any[];
|
|
22
|
-
//#endregion
|
|
23
|
-
export { TypeParameters, TypeParametersProps, __ΩTypeParametersProps };
|
|
24
|
-
//# sourceMappingURL=type-parameters.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"type-parameters.d.mts","names":[],"sources":["../../../src/typescript/components/type-parameters.tsx"],"sourcesContent":[],"mappings":";;;;;UAsBiB,mBAAA;EAAA;EAyCD,UAAA,CAAA,EAvCD,uBAuCuB,EAAA,GAAA,MAAA,EAAA;;aArCzB;;;;;;;;;;iBAqCG,cAAA,QAAsB,sBAAmB"}
|