Skip to content

UpgradeCanisterOptions

Defined in: pocket-ic-types.ts:648

Options for upgrading a given canister with a WASM module. This will reset the canister’s heap, but preserve stable memory.

Principal

optional arg: ArrayBufferLike

Defined in: pocket-ic-types.ts:664

Candid encoded argument to pass to the canister’s init function.


canisterId: Principal

Defined in: pocket-ic-types.ts:652

The Principal of the canister to upgrade.


optional sender: Principal

Defined in: pocket-ic-types.ts:670

The Principal to send the request as. Defaults to the anonymous principal.


optional upgradeModeOptions: CanisterInstallModeUpgradeOptions

Defined in: pocket-ic-types.ts:675

The options to pass to the management canister’s upgrade variant in the install code request.


wasm: string | ArrayBufferLike

Defined in: pocket-ic-types.ts:659

The WASM module to install to the canister. If a string is passed, it is treated as a path to a file. If an ArrayBufferLike is passed, it is treated as the WASM module itself.