JS Utils Kit - v0.5.4
    Preparing search index...

    Interface CreateArchiveOptions

    Configuration options.

    interface CreateArchiveOptions {
        format: ArchiveFormat;
        source: string;
        destination: string;
        options?: ArchiverOptions;
        log?: boolean;
        onSuccess?: (bytes: number) => void;
    }
    Index

    Properties

    format source destination options? log? onSuccess?

    Properties

    format: ArchiveFormat

    Archive format to use ArchiveFormat.

    source: string

    Path to the source directory that should be archived.

    destination: string

    Destination file path where the archive will be written

    - For `zip` format: `dist.zip`
     - For `tar` format: `dist.tar`
    options?: ArchiverOptions

    Additional options passed directly to the archiver library. See ArchiverOptions.

    log?: boolean

    Optional flag to enable internal logging. Useful for CLI mode.

    onSuccess?: (bytes: number) => void

    Called after archiving is complete — receives total size in bytes.

    Settings

    Member Visibility

    On This Page

    Properties