UpdateCanisterSettingsOptions
Defined in: packages/pic/src/pocket-ic-types.ts:754
Options for updating the settings of a given canister.
Extends
Section titled “Extends”Partial<CanisterSettings>
Properties
Section titled “Properties”canisterId
Section titled “canisterId”canisterId:
Principal
Defined in: packages/pic/src/pocket-ic-types.ts:758
The Principal of the canister to update the settings for.
computeAllocation?
Section titled “computeAllocation?”
optionalcomputeAllocation:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:510
The compute allocation of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.computeAllocation
controllers?
Section titled “controllers?”
optionalcontrollers:Principal[]
Defined in: packages/pic/src/pocket-ic-types.ts:505
The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.
Inherited from
Section titled “Inherited from”environmentVariables?
Section titled “environmentVariables?”
optionalenvironmentVariables:EnvironmentVariable[]
Defined in: packages/pic/src/pocket-ic-types.ts:556
Environment variables exposed to the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.environmentVariables
freezingThreshold?
Section titled “freezingThreshold?”
optionalfreezingThreshold:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:520
The freezing threshold of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.freezingThreshold
logMemoryLimit?
Section titled “logMemoryLimit?”
optionallogMemoryLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:540
The log memory limit of the canister in bytes.
Inherited from
Section titled “Inherited from”CanisterSettings.logMemoryLimit
logVisibility?
Section titled “logVisibility?”
optionallogVisibility:LogVisibility
Defined in: packages/pic/src/pocket-ic-types.ts:530
The log visibility of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.logVisibility
memoryAllocation?
Section titled “memoryAllocation?”
optionalmemoryAllocation:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:515
The memory allocation of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.memoryAllocation
reservedCyclesLimit?
Section titled “reservedCyclesLimit?”
optionalreservedCyclesLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:525
The reserved cycles limit of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.reservedCyclesLimit
sender?
Section titled “sender?”
optionalsender:Principal
Defined in: packages/pic/src/pocket-ic-types.ts:764
The Principal to send the request as. Defaults to the anonymous principal.
snapshotVisibility?
Section titled “snapshotVisibility?”
optionalsnapshotVisibility:SnapshotVisibility
Defined in: packages/pic/src/pocket-ic-types.ts:535
The snapshot visibility of the canister.
Inherited from
Section titled “Inherited from”CanisterSettings.snapshotVisibility
wasmMemoryLimit?
Section titled “wasmMemoryLimit?”
optionalwasmMemoryLimit:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:545
The WASM memory limit of the canister in bytes.
Inherited from
Section titled “Inherited from”CanisterSettings.wasmMemoryLimit
wasmMemoryThreshold?
Section titled “wasmMemoryThreshold?”
optionalwasmMemoryThreshold:bigint
Defined in: packages/pic/src/pocket-ic-types.ts:551
The WASM memory threshold of the canister in bytes. The canister_on_low_wasm_memory function will be called when the canister’s remaining wasm memory is below this threshold.