ClientManagerParameters
Defined in: types/client.ts:14
Parameters for configuring a ClientManager instance.
Properties
Section titled “Properties”queryClient
Section titled “queryClient”queryClient:
QueryClient
Defined in: types/client.ts:18
The TanStack QueryClient used for caching and state management.
agentOptions?
Section titled “agentOptions?”
optionalagentOptions:HttpAgentOptions
Defined in: types/client.ts:22
Optional configuration for the underlying HttpAgent.
optionalport:number
Defined in: types/client.ts:26
The port used for the local IC replica (default is 4943).
withLocalEnv?
Section titled “withLocalEnv?”
optionalwithLocalEnv:boolean
Defined in: types/client.ts:30
If true, configures the agent for a local environment.
withProcessEnv?
Section titled “withProcessEnv?”
optionalwithProcessEnv:boolean
Defined in: types/client.ts:34
If true, auto-configures the agent based on process.env settings.
authClient?
Section titled “authClient?”
optionalauthClient: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.