import { type ITypingsGeneratorOptions, TypingsGenerator, type ITypingsGeneratorOptionsWithCustomReadFile } from './TypingsGenerator'; import type { ISourcePosition } from './DeclarationMap'; /** * @public */ export interface IStringValueTyping { exportName: string; comment?: string; /** * The zero-based position of this string's declaration in the source file. When provided and * declaration maps are enabled, "go to definition" resolves to this position. */ sourcePosition?: ISourcePosition; } /** * @public */ export interface IStringValueTypings { typings: IStringValueTyping[]; /** * Options for default exports. Note that options provided here will override * options provided in {@link IStringValuesTypingsGeneratorBaseOptions.exportAsDefault}. */ exportAsDefault?: boolean | IExportAsDefaultOptions; } /** * @public */ export interface IExportAsDefaultOptions { /** * This setting overrides the the interface name for the default wrapped export. * * @defaultValue "IExport" */ interfaceName?: string; /** * @deprecated - Use {@link IExportAsDefaultOptions.interfaceDocumentationComment} instead. */ documentationComment?: string; /** * This value is placed in a documentation comment for the * exported default interface. */ interfaceDocumentationComment?: string; /** * This value is placed in a documentation comment for the * exported const value. */ valueDocumentationComment?: string; } /** * @public */ export interface IStringValuesTypingsGeneratorBaseOptions { /** * Setting this option wraps the typings export in a default property. */ exportAsDefault?: boolean | IExportAsDefaultOptions; /** * @deprecated Use {@link IStringValuesTypingsGeneratorBaseOptions.exportAsDefault}'s * {@link IExportAsDefaultOptions.interfaceName} instead. */ exportAsDefaultInterfaceName?: string; } /** * @public */ export interface IStringValuesTypingsGeneratorOptions extends ITypingsGeneratorOptions, IStringValuesTypingsGeneratorBaseOptions { } /** * @public */ export interface IStringValuesTypingsGeneratorOptionsWithCustomReadFile extends ITypingsGeneratorOptionsWithCustomReadFile, IStringValuesTypingsGeneratorBaseOptions { } /** * This is a simple tool that generates .d.ts files for non-TS files that can be represented as * a simple set of named string exports. * * @public */ export declare class StringValuesTypingsGenerator extends TypingsGenerator { constructor(options: TFileContents extends string ? IStringValuesTypingsGeneratorOptions : never); constructor(options: IStringValuesTypingsGeneratorOptionsWithCustomReadFile); } //# sourceMappingURL=StringValuesTypingsGenerator.d.ts.map