Skip to content
Internet Computer Logo ICP JS SDK Docs

UpgradeCanisterOptions

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

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

Principal

Properties

Section titled “Properties”

arg?

Section titled “arg?”

optional arg: ArrayBufferLike

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

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

canisterId

Section titled “canisterId”

canisterId: Principal

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

The Principal of the canister to upgrade.

sender?

Section titled “sender?”

optional sender: Principal

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

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

wasm

Section titled “wasm”

wasm: string | ArrayBufferLike

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

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.