@manuth/woltlab-compiler/lib/PackageSystem/IComponentOptions.d.ts

A compiler for generating WoltLab-Package `.tar` Archives and other WoltLab-Package Components

import { ILocalization } from "../Globalization/ILocalization.js";
import { IPersonOptions } from "./IPersonOptions.js";
import { VersionNumber } from "./VersionNumber.js";
/**
 * Provides options for the {@link Component `Component`} class.
 */
export interface IComponentOptions {
    /**
     * The human-readable name of the component.
     */
    DisplayName: ILocalization;
    /**
     * The version of the component.
     */
    Version: VersionNumber;
    /**
     * The author of the component.
     */
    Author?: IPersonOptions;
    /**
     * The creation-date of the component.
     */
    CreationDate?: Date;
    /**
     * The description of the component.
     */
    Description?: ILocalization;
    /**
     * The license of the component.
     */
    License?: string;
}