import type { Node } from "./builder"; /** * Type of rule * @category Builder types * * @since 1.0.0 * @author Simon Kovtyk */ type Type = "hyphens" | "asterisks" | "underscores"; /** * Builder-element for a horizontal rule * @param type - Type of this element * @param repeats - Number of repeating characters * @returns A markdown node * @category Builder * @example * ```ts * import { define, rule } from "@ogs-gmbh/markdown"; * * const markdown = define( * rule("hyphen") * ); * * console.assert( * markdown.toString() * ); * ``` * * @see https://github.com/adam-p/markdown-here/wiki/markdown-cheatsheet#hr * @since 1.0.0 * @author Simon Kovtyk */ declare function rule(type?: Type, repeats?: number): Node; export type { Type as RuleType }; export { rule }; //# sourceMappingURL=rule.d.ts.map