@powerlines/plugin-alloy 0.19.13 → 0.19.14

package/dist/tsdoc-OUuKjTbh.d.mts

@@ -0,0 +1,164 @@
+import { n as ComponentProps } from "./components-oHSM7vmp.mjs";
+import { Children } from "@alloy-js/core";
+import { ReflectionKind, ReflectionParameter, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
+import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
+
+//#region src/typescript/components/tsdoc.d.ts
+interface TSDocProps extends ComponentProps {
+  heading?: Children;
+}
+/**
+ * Generates a TypeScript interface for the given reflection class.
+ */
+declare function TSDoc(props: TSDocProps): Children;
+interface TSDocTagProps extends ComponentProps {
+  tag: string;
+}
+/**
+ * Create a TSDoc `@<props.tag>` tag.
+ */
+declare function TSDocTag(props: TSDocTagProps): Children;
+interface TSDocParamsProps {
+  parameters: ParameterDescriptor[] | string[];
+}
+/**
+ * A component that creates a TSDoc block with `@param` tags for each parameter.
+ */
+declare function TSDocParams(props: TSDocParamsProps): Children;
+/**
+ * Create a TSDoc `@title` tag.
+ */
+declare function TSDocTitle(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@domain` tag.
+ */
+declare function TSDocDomain(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@alias` tag.
+ */
+declare function TSDocAlias(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@permission` tag.
+ */
+declare function TSDocPermission(props: ComponentProps): Children;
+interface TSDocDefaultValueProps extends ComponentProps {
+  type: ReflectionKind | ReflectionProperty | ReflectionParameter;
+  defaultValue: any;
+}
+/**
+ * Create a TSDoc `@defaultValue` tag.
+ */
+declare function TSDocDefaultValue(props: TSDocDefaultValueProps): Children;
+/**
+ * Create a TSDoc `@remarks` tag.
+ */
+declare function TSDocRemarks(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@see` tag.
+ */
+declare function TSDocLink(props: ComponentProps): Children;
+interface TSDocExampleProps extends JSDocExampleProps {
+  /**
+   * Whether the file is a TSX file.
+   *
+   * @defaultValue false
+   */
+  tsx?: boolean;
+}
+/**
+ * Create a TSDoc `@example` tag.
+ */
+declare function TSDocExample(props: TSDocExampleProps): Children;
+/**
+ * Create a TSDoc `@readonly` tag.
+ */
+declare function TSDocReadonly(): Children;
+/**
+ * Create a TSDoc `@internal` tag.
+ */
+declare function TSDocInternal(): Children;
+/**
+ * Create a TSDoc `@ignore` tag.
+ */
+declare function TSDocIgnore(): Children;
+/**
+ * Create a TSDoc `@hidden` tag.
+ */
+declare function TSDocHidden(): Children;
+interface TSDocAttributesTagsProps {
+  type?: ReflectionKind | ReflectionProperty | ReflectionParameter;
+  title?: string;
+  alias?: string[];
+  permission?: string[];
+  domain?: string;
+  readonly?: boolean;
+  internal?: boolean;
+  ignore?: boolean;
+  hidden?: boolean;
+  defaultValue?: any;
+}
+/**
+ * Generates a TypeScript interface property for the given reflection class.
+ */
+declare function TSDocAttributesTags(props: TSDocAttributesTagsProps): Children;
+interface TSDocParamProps {
+  name: Children;
+  children?: Children;
+  optional?: boolean;
+  defaultValue?: Children;
+}
+/**
+ * Create a TSDoc parameter set off with `@param`.
+ */
+declare function TSDocParam(props: TSDocParamProps): Children;
+/**
+ * Create a TSDoc `@returns` tag.
+ */
+declare function TSDocReturns(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@throws` tag.
+ */
+declare function TSDocThrows(props: ComponentProps): Children;
+interface TSDocModuleProps extends ComponentProps {
+  /**
+   * The prefix for the builtin module name
+   *
+   * @remarks
+   * This value is populated from the Powerlines configuration output builtin prefix by default.
+   *
+   * @example
+   * ```ts
+   * /**
+   *  @module powerlines:my-module
+   *  \/
+   * ```
+   */
+  prefix?: string;
+  /**
+   * The name of the module
+   *
+   * @remarks
+   * This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.
+   *
+   * @example
+   * ```ts
+   * import { MyModule } from "powerlines:my-module";
+   * ```
+   */
+  name: Children;
+}
+/**
+ * Generates a TSDoc `@module` tag for the given module name.
+ */
+declare function TSDocModule(props: TSDocModuleProps): Children;
+declare type __ΩTSDocProps = any[];
+declare type __ΩTSDocTagProps = any[];
+declare type __ΩTSDocParamsProps = any[];
+declare type __ΩTSDocDefaultValueProps = any[];
+declare type __ΩTSDocExampleProps = any[];
+declare type __ΩTSDocAttributesTagsProps = any[];
+declare type __ΩTSDocParamProps = any[];
+declare type __ΩTSDocModuleProps = any[];
+//#endregion
+export { __ΩTSDocDefaultValueProps as A, TSDocRemarks as C, TSDocThrows as D, TSDocTagProps as E, __ΩTSDocProps as F, __ΩTSDocTagProps as I, __ΩTSDocModuleProps as M, __ΩTSDocParamProps as N, TSDocTitle as O, __ΩTSDocParamsProps as P, TSDocReadonly as S, TSDocTag as T, TSDocParamProps as _, TSDocDefaultValue as a, TSDocPermission as b, TSDocExample as c, TSDocIgnore as d, TSDocInternal as f, TSDocParam as g, TSDocModuleProps as h, TSDocAttributesTagsProps as i, __ΩTSDocExampleProps as j, __ΩTSDocAttributesTagsProps as k, TSDocExampleProps as l, TSDocModule as m, TSDocAlias as n, TSDocDefaultValueProps as o, TSDocLink as p, TSDocAttributesTags as r, TSDocDomain as s, TSDoc as t, TSDocHidden as u, TSDocParams as v, TSDocReturns as w, TSDocProps as x, TSDocParamsProps as y };
+//# sourceMappingURL=tsdoc-OUuKjTbh.d.mts.map

package/dist/tsdoc-OUuKjTbh.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsdoc-OUuKjTbh.d.mts","names":[],"sources":["../src/typescript/components/tsdoc.tsx"],"sourcesContent":[],"mappings":";;;;;;UAuCiB,UAAA,SAAmB;YACxB;AADZ;AAOA;AAgCA;AAOA;AAgBiB,iBAvDD,KAAA,CAuDiB,KAAA,EAvDJ,UAwDf,CAAA,EAxDyB,QAwDN;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;AAmBA;AAagB,iBApHA,WAAA,CAoHiB,KAAA,EApHE,gBAoHY,CAAA,EApHI,QAoHJ;AAI/C;AAYA;AA4BA;AAOgB,iBA5IA,UAAA,CA4Ia,KAAA,EA5IK,cA4IL,CAAA,EA5ImB,QA4InB;AAO7B;AAOA;AAIA;AACS,iBAlJO,WAAA,CAkJP,KAAA,EAlJ0B,cAkJ1B,CAAA,EAlJwC,QAkJxC;;;;AAeO,iBApJA,UAAA,CAoJmB,KAAQ,EApJT,cAoJS,CAAA,EApJK,QAoJmB;AA+EnE;;;AAIiB,iBA1ND,eAAA,CA0NC,KAAA,EA1NsB,cA0NtB,CAAA,EA1NoC,QA0NpC;AAAQ,UAhNR,sBAAA,SAA+B,cAgNvB,CAAA;EAMT,IAAA,EArNR,cAqNkB,GArND,kBAqNS,GArNY,mBAqNG;EAiDjC,YAAA,EAAA,GAAY;AAO5B;AAIA;AAiCA;;iBA3SgB,iBAAA,QAAyB,yBAAsB;;;;iBAmB/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;UA+ElD,eAAA;QACT;aACK;;iBAEI;;;;;iBAMD,UAAA,QAAkB,kBAAe;;;;iBAiDjC,YAAA,QAAoB,iBAAc;;;;iBAOlC,WAAA,QAAmB,iBAAc;UAIhC,gBAAA,SAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;QA2BlC;;;;;iBAMQ,WAAA,QAAmB,mBAAgB"}