@salesforce/b2c-tooling-sdk / operations/jobs / SiteArchiveImportOptions

Interface: SiteArchiveImportOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:28

Options for site archive import.

Properties

keepArchive?

optional keepArchive: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:30

Keep archive on instance after import (default: false)

---

maxBytes?

optional maxBytes: number

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:54

Optional soft size ceiling (in bytes) for the assembled archive. When set along with SiteArchiveImportOptions.onOversize and the archive exceeds it, the callback is invoked before upload — the import still proceeds. The SDK itself does not warn or block; the consumer decides how to react. Use siteArchiveImportSplit to split oversized imports.

---

onOversize()?

optional onOversize: (info) => void

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:60

Called before upload when the assembled archive exceeds maxBytes. Lets the consumer (e.g. the CLI) surface its own guidance. Receives the archive size and the configured ceiling.

Parameters

info

bytes

number

maxBytes

number

Returns

void

---

paths?

optional paths: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:46

Optional list of paths or glob patterns to include in the archive when importing from a directory. Each entry may be:

• An absolute path under the root directory
• A path relative to the root directory
• A glob pattern (relative to the root) — magic chars * ? [ ] { }

When omitted, the entire root directory is archived (current behavior). Entries that resolve outside the root directory throw an error. Ignored when target is a zip file, Buffer, or remote filename.

---

wait?

optional wait: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:32

Whether to wait for job completion (default: true)

---

waitOptions?

optional waitOptions: WaitForJobOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:34

Wait options for job completion