Skip to content
Internet Computer Logo ICP JS SDK Docs

CanisterSettings

Defined in: packages/pic/src/pocket-ic-types.ts:537

Canister settings.

See

Section titled “See”

Principal

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

computeAllocation?

Section titled “computeAllocation?”

optional computeAllocation: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:547

The compute allocation of the canister.

controllers?

Section titled “controllers?”

optional controllers: Principal[]

Defined in: packages/pic/src/pocket-ic-types.ts:542

The controllers of the canister. Defaults to the sender, which defaults to the anonymous principal.

environmentVariables?

Section titled “environmentVariables?”

optional environmentVariables: EnvironmentVariable[]

Defined in: packages/pic/src/pocket-ic-types.ts:593

Environment variables exposed to the canister.

freezingThreshold?

Section titled “freezingThreshold?”

optional freezingThreshold: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:557

The freezing threshold of the canister.

logMemoryLimit?

Section titled “logMemoryLimit?”

optional logMemoryLimit: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:577

The log memory limit of the canister in bytes.

logVisibility?

Section titled “logVisibility?”

optional logVisibility: LogVisibility

Defined in: packages/pic/src/pocket-ic-types.ts:567

The log visibility of the canister.

memoryAllocation?

Section titled “memoryAllocation?”

optional memoryAllocation: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:552

The memory allocation of the canister.

reservedCyclesLimit?

Section titled “reservedCyclesLimit?”

optional reservedCyclesLimit: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:562

The reserved cycles limit of the canister.

snapshotVisibility?

Section titled “snapshotVisibility?”

optional snapshotVisibility: SnapshotVisibility

Defined in: packages/pic/src/pocket-ic-types.ts:572

The snapshot visibility of the canister.

wasmMemoryLimit?

Section titled “wasmMemoryLimit?”

optional wasmMemoryLimit: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:582

The WASM memory limit of the canister in bytes.

wasmMemoryThreshold?

Section titled “wasmMemoryThreshold?”

optional wasmMemoryThreshold: bigint

Defined in: packages/pic/src/pocket-ic-types.ts:588

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.