@manuth/woltlab-compiler/lib/PackageSystem/Instructions/IInstruction.d.ts

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

import { Package } from "../Package.js";
import { InstructionSet } from "./InstructionSet.js";
/**
 * Represents a step of a package-installation.
 */
export interface IInstruction {
    /**
     * Gets the name of the type of the instruction.
     */
    Type: string;
    /**
     * Gets or sets the collection this instruction belongs to.
     */
    Collection: InstructionSet;
    /**
     * Gets the package of this instruction.
     */
    readonly Package: Package;
    /**
     * Gets the directory to save the instruction to.
     */
    DestinationRoot: string;
    /**
     * Gets or sets the name of the file to save the compiled instruction to.
     */
    FileName: string;
    /**
     * Gets the full name of the file.
     */
    FullName: string;
    /**
     * Gets or sets a value indicating whether the instruction should be executed in standalone-mode.
     */
    Standalone: boolean;
    /**
     * Gets all identifiable objects.
     */
    ObjectsByID: Record<string, unknown>;
}