import { t as ComponentProps } from "./components-U6HOf5GS.mjs";
import { Children } from "@alloy-js/core";
import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
import { JsonSchemaPrimitiveType } from "@power-plant/schema";
//#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;
/**
 * Create a TSDoc `@group` tag.
 */
declare function TSDocGroup(props: ComponentProps): Children;
interface TSDocDefaultValueProps extends ComponentProps {
  type?: JsonSchemaPrimitiveType | string;
  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;
/**
 * Create a TSDoc `@runtime` tag.
 */
declare function TSDocRuntime(): Children;
interface TSDocAttributesTagsProps {
  type?: JsonSchemaPrimitiveType | string;
  default?: any;
  title?: string;
  alias?: string[];
  tags?: string[];
  readOnly?: boolean;
  internal?: boolean;
  ignore?: boolean;
  hidden?: boolean;
  runtime?: boolean;
}
/**
 * Generates a TypeScript interface property for the given reflection class.
 */
declare function TSDocAttributesTags(props: TSDocAttributesTagsProps): Children;
interface TSDocParamProps {
  name: Children;
  children?: Children;
  optional?: boolean;
  default?: 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 used to prefix the module name in the `@module` tag and the import path for the module, e.g. `prefix:name`.
   *
   * @example
   * ```ts
   * /**
   *  @module prefix:name
   *  \/
   * ```
   */
  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. `prefix:name`.
   *
   * @example
   * ```ts
   * import { MyModule } from "prefix:name";
   * ```
   */
  name: Children;
}
/**
 * Generates a TSDoc `@module` tag for the given module name.
 */
declare function TSDocModule(props: TSDocModuleProps): Children;
//#endregion
export { TSDocTitle as A, TSDocReadonly as C, TSDocTag as D, TSDocRuntime as E, TSDocTagProps as O, TSDocProps as S, TSDocReturns as T, TSDocParam as _, TSDocDefaultValue as a, TSDocParamsProps as b, TSDocExample as c, TSDocHidden as d, TSDocIgnore as f, TSDocModuleProps as g, TSDocModule as h, TSDocAttributesTagsProps as i, TSDocThrows as k, TSDocExampleProps as l, TSDocLink as m, TSDocAlias as n, TSDocDefaultValueProps as o, TSDocInternal as p, TSDocAttributesTags as r, TSDocDomain as s, TSDoc as t, TSDocGroup as u, TSDocParamProps as v, TSDocRemarks as w, TSDocPermission as x, TSDocParams as y };
//# sourceMappingURL=tsdoc-J_tHTMei.d.mts.map