Type Alias CreateArchiveOptions

Options to control archive creation.

type CreateArchiveOptions = {
    excludes?: string[];
    fileName?: string;
    includeOutputDir?: boolean;
    includes?: string[];
}

Properties

excludes?: string[]

Deny‑list globs. Defaults include .git, node_modules, and STAN workspace rules. These are applied only when includes is empty.

fileName?: string

Archive file name. If provided without .tar, the suffix is added. Written to stanPath/output/<fileName>.

includeOutputDir?: boolean

When true, include the stanPath/output directory inside the archive.

includes?: string[]

Allow‑list globs; when provided, overrides excludes.