@minecraft/creator-tools/lib/storage/IFolder.d.ts

Minecraft Creator Tools command line and libraries.

import { IEvent } from "ste-events";
import IFile from "./IFile";
import IStorage, { IFolderMove } from "./IStorage";
import IStorageObject from "./IStorageObject";
export declare enum FolderErrorStatus {
    none = 0,
    unreadable = 1
}
export default interface IFolder extends IStorageObject {
    lastLoadedOrSaved: Date | null;
    parentFolder: IFolder | null;
    storage: IStorage;
    ensuredName: string;
    extendedPath: string;
    fileCount: number;
    folderCount: number;
    folders: {
        [name: string]: IFolder | undefined;
    };
    files: {
        [name: string]: IFile | undefined;
    };
    allFiles: AsyncIterable<IFile>;
    isLoaded: boolean;
    canIgnore: boolean;
    errorStatus?: FolderErrorStatus;
    onFolderMoved: IEvent<IFolder, IFolderMove>;
    onChildFolderMoved: IEvent<IFolder, IFolderMove>;
    rename(name: string): Promise<boolean>;
    moveTo(newStorageRelativePath: string): Promise<boolean>;
    load(force?: boolean): Promise<Date>;
    exists(): Promise<boolean>;
    ensureExists(): Promise<boolean>;
    dispose(): void;
    deleteThisFolder(): Promise<boolean>;
    deleteAllFolderContents(): Promise<boolean>;
    deleteFileFromRelativePath(path: string): Promise<boolean>;
    removeFolder(name: string): boolean;
    getFileFromRelativePath(serverRelativePath: string): Promise<IFile | undefined>;
    getFolderFromRelativePath(serverRelativePath: string): Promise<IFolder | undefined>;
    getFolderFromRelativePathLocal(serverRelativePath: string): IFolder | undefined;
    getFolderByIndex(index: number): IFolder | undefined;
    getSortedFolderKeys(): string[];
    getSortedFileKeys(): string[];
    scanForChanges(): Promise<void>;
    ensureFolderFromRelativePath(serverRelativePath: string): Promise<IFolder>;
    ensureFileFromRelativePath(serverRelativePath: string): Promise<IFile>;
    setStructureFromFileList(fileList: string[]): Promise<void>;
    saveAll(force?: boolean): Promise<boolean>;
    clearAllManagers(): void;
    getFolderRelativePath(toFolder: IFolder): string | undefined;
    folderExists(name: string): boolean;
    fileExists(name: string): boolean;
    ensureFolder(name: string): IFolder;
    ensureFile(name: string): IFile;
    deleteFile(name: string): Promise<boolean>;
    createFile(name: string): Promise<IFile>;
}