Skip to content

API Reference


Interface: CustomCanisterScope

Defined in: docs-entry.ts:691

A Custom (pre-compiled Wasm) canister scope containing all available tasks. Created by calling .make() on a CustomCanisterBuilder.

Properties

_tag

_tag: "scope"

Defined in: docs-entry.ts:692


children

children: object

Defined in: docs-entry.ts:693

bindings

bindings: Task

Generates TypeScript/JavaScript bindings from the Candid file.

build

build: Task

Validates the Wasm file exists (no compilation needed).

config

config: Task

Returns the canister configuration.

create

create: Task

Creates the canister on the replica (allocates canister ID).

deploy

deploy: Task

Smart deployment: creates and installs in one step.

install

install: Task

Installs or upgrades the Wasm code on the canister.

install_args

install_args: Task

Computes and returns the install arguments.

remove

remove: Task

Removes/deletes the canister from the replica.

status

status: Task

Returns the current canister status (running, stopped, etc.).

stop

stop: Task

Stops the canister.