@manuth/generator-wsc-package/lib/generators/package/Components/FileUploadComponent.d.ts

A Generator for WoltLab Suite Core Packages.

/// <reference types="yeoman-generator" />
import { GeneratorOptions, IFileMapping } from "@manuth/extended-yo-generator";
import { IPathQuestion } from "@manuth/generator-ts-project";
import { FileUploadComponentBase } from "../../../Components/FileUploadComponentBase.js";
import { IApplicationQuestion } from "../../../Components/Inquiry/Prompts/IApplicationQuestion.js";
import { IFileUploadComponentOptions } from "../../../Settings/IFileUploadComponentOptions.js";
import { IWoltLabSettings } from "../../../Settings/IWoltLabSettings.js";
import { WoltLabGenerator } from "../../../WoltLabGenerator.js";
/**
 * Provides a component for uploading files.
 *
 * @template TSettings
 * The type of the settings of the generator.
 *
 * @template TOptions
 * The type of the options of the generator.
 *
 * @template TComponentOptions
 * The type of the options of the component.
 */
export declare class FileUploadComponent<TSettings extends IWoltLabSettings, TOptions extends GeneratorOptions, TComponentOptions extends IFileUploadComponentOptions> extends FileUploadComponentBase<TSettings, TOptions, TComponentOptions> {
    /**
     * Initializes a new instance of the {@link FileUploadComponent `FileUploadComponent<TSettings, TOptions, TComponentOptions>`} class.
     *
     * @param generator
     * The generator of the component.
     */
    constructor(generator: WoltLabGenerator<TSettings, TOptions>);
    /**
     * @inheritdoc
     */
    get ID(): string;
    /**
     * @inheritdoc
     */
    get DisplayName(): string;
    /**
     * @inheritdoc
     */
    get FileMappings(): Array<IFileMapping<TSettings, TOptions>>;
    /**
     * Gets the default name of the folder to suggest in the {@link TemplateComponent.SourceQuestion `SourceQuestion`}.
     */
    protected get DefaultSourceBaseName(): string;
    /**
     * @inheritdoc
     */
    protected get AppQuestion(): IApplicationQuestion<TComponentOptions>;
    /**
     * @inheritdoc
     */
    protected get SourceQuestion(): IPathQuestion<TComponentOptions>;
    /**
     * Gets the file-mapping for creating the example-file.
     */
    protected get ExampleFileMapping(): IFileMapping<TSettings, TOptions>;
    /**
     * @inheritdoc
     *
     * @param options
     * The options which have been provided by the user.
     *
     * @returns
     * The name of the instruction-class.
     */
    protected GetClassName(options: TComponentOptions): string;
}