DownloadCanisterSnapshotOptions
Defined in: packages/pic/src/pocket-ic-types.ts:1438
Options for downloading a snapshot of a canister to a directory.
Extends
Section titled “Extends”Properties
Section titled “Properties”canisterId
Section titled “canisterId”canisterId:
Principal
Defined in: packages/pic/src/pocket-ic-types.ts:1398
The Principal of the canister the snapshot belongs to.
Inherited from
Section titled “Inherited from”CanisterSnapshotOptions.canisterId
sender?
Section titled “sender?”
optionalsender:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:1450
The Principal to send the request as. Defaults to the anonymous principal. It must be a controller unless the canister’s snapshot visibility allows it.
Overrides
Section titled “Overrides”CanisterSnapshotOptions.sender
snapshotDir
Section titled “snapshotDir”snapshotDir:
string
Defined in: packages/pic/src/pocket-ic-types.ts:1443
The directory to download the snapshot to, on the machine running the PocketIC server. It must be empty or not exist yet.
snapshotId
Section titled “snapshotId”snapshotId:
Uint8Array
Defined in: packages/pic/src/pocket-ic-types.ts:1403
The ID of the snapshot.