ClientManagerParameters

Defined in: types/client.ts:14

Parameters for configuring a ClientManager instance.

Properties

queryClient

queryClient: QueryClient

Defined in: types/client.ts:18

The TanStack QueryClient used for caching and state management.

---

agentOptions?

optional agentOptions: HttpAgentOptions

Defined in: types/client.ts:22

Optional configuration for the underlying HttpAgent.

---

port?

optional port: number

Defined in: types/client.ts:26

The port used for the local IC replica (default is 4943).

---

withLocalEnv?

optional withLocalEnv: boolean

Defined in: types/client.ts:30

If true, configures the agent for a local environment.

---

withProcessEnv?

optional withProcessEnv: boolean

Defined in: types/client.ts:34

If true, auto-configures the agent based on process.env settings.

---

authClient?

optional authClient: AuthClient

Defined in: types/client.ts:42

Optional pre-initialized AuthClient instance. If provided, the manager will use this instance instead of dynamically importing and creating a new one from @icp-sdk/auth. This is useful for environments where dynamic imports are not supported or when you want to share an AuthClient instance across multiple managers.

---

withCanisterEnv?

optional withCanisterEnv: boolean

Defined in: types/client.ts:53

Experimental

EXPERIMENTAL - If true, uses the canister environment from @icp-sdk/core/agent/canister-env to automatically configure the agent host and root key based on the ic_env cookie.

⚠️ This feature is experimental and may cause issues with update calls on localhost development. Use with caution and only when you need automatic environment detection from the IC SDK.

Default

false