kaven-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

Run7zCommand

  • Run7zCommand(command: string, switches?: any): Promise<string>

  • You must have the 7z executable available in your PATH or in the same directory of your package.json file. On Debian and Ubuntu install the p7zip-full package. On Windows use the 7z.exe binary. On Mac OSX use Homebrew brew install p7zip

    version

    1.0.0

    since

    1.0.5

    Parameters

    • command: string
    • Optional switches: any

    Returns Promise<string>

SevenZipFiles

  • SevenZipFiles(files: string[], fileName: string, password?: string): Promise<string | Error>
  • version

    1.0.0

    since

    1.0.5

    Parameters

    • files: string[]
    • fileName: string
    • Optional password: string

    Returns Promise<string | Error>

SevenZipFolder

  • SevenZipFolder(folderPath: string, fileName: string, password?: string): Promise<string>
  • version

    1.0.0

    since

    1.0.5

    example
     SevenZipFolder("./dist/", "dist.7z")
 SevenZipFolder("./dist/*", "dist.7z")

    Parameters

    • folderPath: string
    • fileName: string
    • Optional password: string

    Returns Promise<string>

ZipFolder

  • ZipFolder(folderPath: string, fileName: string, topFolderName?: string, options?: { compressionLevel: number; password?: string }): Promise<string>
  • version

    1.0.5

    since

    2020-07-29

    Parameters

    • folderPath: string
    • fileName: string
    • topFolderName: string = ...
    • Optional options: { compressionLevel: number; password?: string }
      • compressionLevel: number

        NO_COMPRESSION - 0

        BEST_SPEED - 1

        BEST_COMPRESSION - 9 default

      • Optional password?: string

    Returns Promise<string>

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration
  • Class

Generated using TypeDoc