/** * Take a string and return a doc block comment. * @param string - The raw text to be included in the comment. * @throws If the string already contains a comment. * @returns A block doc comment string that can be for example prepended to a * bundled JavaScript file. */ export declare function textToComment(string: string): string; /** * Options for {@link generateHeader}. */ export interface HeaderOptions { /** Any text to be appended to the standard header. */ customText: string; /** The build date. */ date: string; /** A description of the project. */ description: string; /** An URL to the homepage of the project. */ homepage: string; /** The name of the project. */ name: string; /** The version of the build. */ version: string; } /** * Generate a dynamic header banner. * @param options - Optional information to be included. Otherwise no custom * text will be appended, the date will be the time when this module was * imported (most likely the start of the build process) and the rest will be * read from package.json. * @throws If the string already contains a comment. * @returns Ready to use banner text. */ export declare function generateHeader(options?: Partial): Promise; //# sourceMappingURL=header.d.ts.map