tnp-helpers 18.0.23 → 18.0.25

package/lib/helpers/for-backend/helpers-file-folders.d.ts

@@ -0,0 +1,104 @@
+import type { CopyOptionsSync } from 'fs-extra';
+export interface GetRecrusiveFilesFromOptions {
+}
+export declare class HelpersFileFolders {
+    /**
+     * Calculate file or string checksum
+     */
+    checksum(absolutePathToFileOrContent: string, algorithm?: 'md5' | 'sha1'): string;
+    getValueFromJSON(filepath: string, lodashGetPath: string, defaultValue?: any): any;
+    getValueFromJSONC(filepath: string, lodashGetPath: string, defaultValue?: any): any;
+    readValueFromJson(filepath: string, lodashGetPath: string, defaultValue?: any): any;
+    readValueFromJsonC(filepath: string, lodashGetPath: string, defaultValue?: any): any;
+    setValueToJSON(filepath: string, lodashGetPath: string, value: any): void;
+    setValueToJSONC(filepath: string, lodashGetPath: string, value: any): void;
+    /**
+     * file size in bytes
+     */
+    size(filePath: string): number;
+    pathFromLink(filePath: string): string;
+    /**
+     * @deprecated
+     */
+    renameFolder(from: string, to: string, cwd?: string): void;
+    /**
+     * @deprecated
+     */
+    renameFiles(from: string, to: string, cwd?: string): void;
+    getTempFolder(): string;
+    isPlainFileOrFolder(filePath: string): boolean;
+    /**
+     * @deprecated
+     * use import (or modules only on backend)
+     */
+    requireUncached(module: string): any;
+    /**
+     * @deprecated
+     * use import (or modules only on backend)
+     *
+     * get default export object from  js file
+     * @param jsFilePath
+     */
+    require(jsFilePath: string): any;
+    tryRecreateDir(dirpath: string): void;
+    /**
+     * @deprecated
+     */
+    tryCopyFrom(source: string, destination: string, options?: {}): void;
+    move(from: string, to: string): void;
+    findChildren<T>(location: string, createFn: (childLocation: string) => T, options?: {
+        allowAllNames: boolean;
+    }): T[];
+    /**
+     * @deprecated
+     */
+    findChildrenNavi<T>(location: string, createFn: (childLocation: string) => T): T[];
+    /**
+     * get all files from folder
+     * absolute paths
+     */
+    getRecrusiveFilesFrom(dir: string, ommitFolders?: string[], options?: GetRecrusiveFilesFromOptions): string[];
+    checkIfNameAllowedForTaonProj(folderName: string): boolean;
+    getLinesFromFiles(filename: string, lineCount?: number): Promise<string[]>;
+    /**
+     * Get the most recent changes file in direcory
+     * @param dir absoulute path to file
+     */
+    getMostRecentFileName(dir: string): string;
+    getMostRecentFilesNames(dir: string): string[];
+    removeExcept(fromPath: string, exceptFolderAndFiles: string[]): void;
+    copy(sourceDir: string, destinationDir: string, options?: {
+        filter?: any;
+        overwrite?: boolean;
+        recursive?: boolean;
+        asSeparatedFiles?: boolean;
+        asSeparatedFilesAllowNotCopied?: boolean;
+        asSeparatedFilesSymlinkAsFile?: boolean;
+        /**
+         * folders to omit: example: ['src','node_modules']
+         *
+         * This option works only with omitFoldersBaseFolder
+         */
+        omitFolders?: string[];
+        /**
+         * absolute path for base folder for omitFolder option
+         */
+        omitFoldersBaseFolder?: string;
+        copySymlinksAsFiles?: boolean;
+        copySymlinksAsFilesDeleteUnexistedLinksFromSourceFirst?: boolean;
+        useTempFolder?: boolean;
+        dontAskOnError?: boolean;
+    } & CopyOptionsSync): void;
+    filterDontCopy(basePathFoldersTosSkip: string[], projectOrBasepath: string): (src: string, dest: string) => boolean;
+    filterOnlyCopy(basePathFoldersOnlyToInclude: string[], projectOrBasepath: string): (src: string, dest: string) => boolean;
+    copyFile(sourcePath: string, destinationPath: string, options?: {
+        transformTextFn?: (input: string) => string;
+        debugMode?: boolean;
+        fast?: boolean;
+        dontCopySameContent?: boolean;
+    }): boolean;
+    /**
+     * get real absolute path
+     */
+    resolve(fileOrFolderPath: string): string;
+}