Tanatloc documentation
    Preparing search index...

    Variable defaultConst

    default: {
        archive: (
            target: string,
            directory: { C: string; path: string },
        ) => Promise<void>;
        convert: (
            location: string,
            file: { name: string; target: string },
            callback?: (data: { data?: string; error?: string }) => void,
            param?: { isResult: boolean },
        ) => Promise<{ brep?: string; glb: string; name: string }[]>;
        copyDirectory: (origin: string, destination: string) => Promise<void>;
        copyFile: (
            origin: { file: string; path: string },
            destination: { file: string; path: string },
        ) => Promise<void>;
        createPath: (location: string) => Promise<void>;
        decrypt: (hash: { content: string; iv: string }) => Promise<string>;
        encrypt: (text: string) => Promise<{ content: string; iv: string }>;
        listDirectories: (location: string) => Promise<string[]>;
        listFiles: (location: string) => Promise<Dirent<string>[]>;
        readFile: (file: string, options?: any) => Promise<Buffer<ArrayBufferLike>>;
        readJSONFile: (file: string) => Promise<any>;
        readStream: (file: string) => ReadStream;
        removeDirectory: (dir: string) => Promise<void>;
        removeFile: (file: string) => Promise<void>;
        splitStep: (location: string, fileIn: string) => Promise<string[]>;
        toPosix: (str: string) => string;
        unarchive: (
            source: string,
            directory: { C: string; path: string },
        ) => Promise<void>;
        writeFile: (
            location: string,
            name: string,
            content: string | Buffer<ArrayBufferLike>,
        ) => Promise<void>;
        writeStream: (file: string) => WriteStream;
    } = ...

    Type Declaration

    • archive: (target: string, directory: { C: string; path: string }) => Promise<void>

      Tar

    • convert: (
          location: string,
          file: { name: string; target: string },
          callback?: (data: { data?: string; error?: string }) => void,
          param?: { isResult: boolean },
      ) => Promise<{ brep?: string; glb: string; name: string }[]>

      Convert file

    • copyDirectory: (origin: string, destination: string) => Promise<void>

      Copy directory

    • copyFile: (
          origin: { file: string; path: string },
          destination: { file: string; path: string },
      ) => Promise<void>

      Copy file

    • createPath: (location: string) => Promise<void>

      Create path (recursive)

    • decrypt: (hash: { content: string; iv: string }) => Promise<string>

      Decrypt hash

    • encrypt: (text: string) => Promise<{ content: string; iv: string }>

      Encrypt text

    • listDirectories: (location: string) => Promise<string[]>

      List directories

    • listFiles: (location: string) => Promise<Dirent<string>[]>

      List files

    • readFile: (file: string, options?: any) => Promise<Buffer<ArrayBufferLike>>

      Read file

    • readJSONFile: (file: string) => Promise<any>
    • readStream: (file: string) => ReadStream

      Create read stream

    • removeDirectory: (dir: string) => Promise<void>

      Remove directory

    • removeFile: (file: string) => Promise<void>

      Remove file

    • splitStep: (location: string, fileIn: string) => Promise<string[]>
    • toPosix: (str: string) => string

      Path to posix

    • unarchive: (source: string, directory: { C: string; path: string }) => Promise<void>
    • writeFile: (
          location: string,
          name: string,
          content: string | Buffer<ArrayBufferLike>,
      ) => Promise<void>

      Write file

    • writeStream: (file: string) => WriteStream

      Create write stream