API Reference
API Reference
Complete API documentation for @ice.ts/runner.
- Essentials — Core functions:
task(),scope(),Ice(),canister, and theTaskCtxexecution context. - Canister Definitions — Builders and configs for Motoko, Rust, Custom, and Remote canisters.
- Config & Environment — Configuration types, replica interfaces, and identity utilities.
Variables
Canister Definitions
- CustomCanisterBuilder
- CustomCanisterConfig
- CustomCanisterScope
- MotokoCanisterBuilder
- MotokoCanisterConfig
- MotokoCanisterScope
- RemoteCanisterBuilder
- RemoteCanisterConfig
- RemoteCanisterScope
- RustCanisterBuilder
- RustCanisterConfig
- RustCanisterScope
Config & Environment
- ICReplica
- PICReplica
- CanisterSettings
- CreateActorParams
- CreateCanisterParams
- GetCanisterStatusParams
- InstallCodeParams
- StopOptions
- TaskCtxExtension
- Deployment
- ICEConfig
- IceConfigLoader
- ICEEnvironment
- ICEGlobalArgs
- ICEUser
- InferIceConfig
- Replica
- TaskTree
- TaskTreeNode
- Ids