Variable createTarballConst

Type Declaration

• • (
        directoryToTarball: string,
        tarballPath: string,
        options?: CreateTarballOptions,
    ): Promise<void>

  • Creates a gzipped tarball from a directory by spawning a process to run OS-installed tar to avoid pulling in npm package dependencies. Note that Windows has tar since Windows 10 1803 (see https://devblogs.microsoft.com/commandline/windows10v1803/.

    It's possible this isn't 100% reliable due to differences in tar versions across platforms. If better normalization is required, consider using the npm package node-tar instead.

    Parameters

    • directoryToTarball: string

      The directory to tarball. The directory name will be used as the root directory in the tarball

    • tarballPath: string

      The path to the tarball to create - must end with '.tar.gz'

    • Optionaloptions: CreateTarballOptions

      See CreateTarballOptions

    Returns Promise<void>