Interface ExportMapPackageOptions

interface ExportMapPackageOptions {
    allowInvalid?: boolean;
    credentials?: "strip" | "reject";
    exportedAt?: string | Date;
    maxEmbeddedBytes?: number;
    maxPackageBytes?: number;
}

Properties

allowInvalid? credentials? exportedAt? maxEmbeddedBytes? maxPackageBytes?

Properties

Optional ReadonlyallowInvalid

allowInvalid?: boolean

Export a package that fails validateMapPackage. Off by default: an artifact that does not satisfy its own schema is not portable, and exporting one just moves the failure to whoever imports it.

Optional Readonlycredentials

credentials?: "strip" | "reject"

"strip" (default) removes credential material and records a redaction. "reject" refuses the export instead, for callers who would rather be told their package carries a secret than have it quietly cleaned.

Optional ReadonlyexportedAt

exportedAt?: string | Date

Timestamp stamped on the envelope. Defaults to now.

Optional ReadonlymaxEmbeddedBytes

maxEmbeddedBytes?: number

Per-value inline-data budget in bytes. Defaults to DEFAULT_MAX_EMBEDDED_BYTES.

Optional ReadonlymaxPackageBytes

maxPackageBytes?: number

Whole-envelope budget in bytes. Defaults to DEFAULT_MAX_PACKAGE_BYTES.

Settings

Member Visibility

On This Page

Properties