Variable defaultConst

Type declaration

• archive: ((target, directory) => Promise<void>)

  • • (target, directory): Promise<void>

    • Tar

      Parameters

      • target: string

        Target
      • directory: {
            C: string;
            path: string;
        }

        Directory

        • C: string

        • path: string

      Returns Promise<void>

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

  • • (location, file, callback?, param?): Promise<{
          brep?: string;
          glb: string;
          name: string;
      }[]>

    • Convert file

      Parameters

      • location: string

        Location
      • file: {
            name: string;
            target: string;
        }

        File

        • name: string

        • target: string

      • Optional callback: ((data) => void)

        Callback

        • • (data): void

          • Parameters

            • data: {
                  data?: string;
                  error?: string;
              }

              • Optional data?: string

              • Optional error?: string

            Returns void

      • Optional param: {
            isResult: boolean;
        }

        Parameters

        • isResult: boolean

      Returns Promise<{
          brep?: string;
          glb: string;
          name: string;
      }[]>

      Data

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

  • • (origin, destination): Promise<void>

    • Copy directory

      Parameters

      • origin: string

        Origin path
      • destination: string

        Destination

      Returns Promise<void>

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

  • • (origin, destination): Promise<void>

    • Copy file

      Parameters

      • origin: {
            file: string;
            path: string;
        }

        Origin path

        • file: string

        • path: string

      • destination: {
            file: string;
            path: string;
        }

        Destination

        • file: string

        • path: string

      Returns Promise<void>

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

  • • (location): Promise<void>

    • Create path (recursive)

      Parameters

      • location: string

        Location path

      Returns Promise<void>

• decrypt: ((hash) => Promise<string>)

  • • (hash): Promise<string>

    • Decrypt hash

      Parameters

      • hash: {
            content: string;
            iv: string;
        }

        Hash

        • content: string

        • iv: string

      Returns Promise<string>

      Decrypted text

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

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

    • Encrypt text

      Parameters

      • text: string

        Text

      Returns Promise<{
          content: string;
          iv: string;
      }>

      Hash

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

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

    • List directories

      Parameters

      • location: string

        Location

      Returns Promise<string[]>

      Directory list

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

  • • (location): Promise<Dirent[]>

    • List files

      Parameters

      • location: string

        Location

      Returns Promise<Dirent[]>

      Files list (with types)

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

  • • (file, options?): Promise<Buffer>

    • Read file

      Parameters

      • file: string

        File name
      • Optional options: any

        Options

      Returns Promise<Buffer>

      File content

• readJSONFile: ((file) => Promise<any>)

  • • (file): Promise<any>

    • Parameters

      • file: string

      Returns Promise<any>

• readStream: ((file) => ReadStream)

  • • (file): ReadStream

    • Create read stream

      Parameters

      • file: string

        File

      Returns ReadStream

      Read stream

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

  • • (dir): Promise<void>

    • Remove directory

      Parameters

      • dir: string

        Directory

      Returns Promise<void>

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

  • • (file): Promise<void>

    • Remove file

      Parameters

      • file: string

        File name

      Returns Promise<void>

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

  • • (location, fileIn): Promise<string[]>

    • Parameters

      • location: string
      • fileIn: string

      Returns Promise<string[]>

• toPosix: ((str) => string)

  • • (str): string

    • Path to posix

      Parameters

      • str: string

        Path

      Returns string

      POSIX path

• unarchive: ((source, directory) => Promise<void>)

  • • (source, directory): Promise<void>

    • Parameters

      • source: string
      • directory: {
            C: string;
            path: string;
        }

        • C: string

        • path: string

      Returns Promise<void>

• writeFile: ((location, name, content) => Promise<void>)

  • • (location, name, content): Promise<void>

    • Write file

      Parameters

      • location: string

        Location
      • name: string

        File name
      • content: string | Buffer

        Content

      Returns Promise<void>

• writeStream: ((file) => WriteStream)

  • • (file): WriteStream

    • Create write stream

      Parameters

      • file: string

        File

      Returns WriteStream

      Write stream