Skip to content
IC Reactor
v3
v2
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Overview
Why IC Reactor
Installation
Quick Start
Local Development
Framework
React Setup
Queries
Mutations
Query Caching
Guides
Authentication
Type Safety
Error Handling
AI Friendliness
Reference
ClientManager
Reactor
DisplayReactor
CandidReactor
CandidDisplayReactor
MetadataReactor
MetadataDisplayReactor
createAuthHooks
Overview
useAuth
useUserPrincipal
useAgentState
createActorHooks
Overview
useActorQuery
useActorMutation
useActorMethod
useActorSuspenseQuery
useActorInfiniteQuery
useActorSuspenseInfiniteQuery
Factories
Overview
createQuery
createSuspenseQuery
createMutation
createInfiniteQuery
createSuspenseInfiniteQuery
Reactor Hooks
Overview
useReactorQuery
useReactorMutation
useReactorMethod
useReactorSuspenseQuery
useReactorInfiniteQuery
useReactorSuspenseInfiniteQuery
Validation
Examples
Overview
All-in-One Demo
ICP Reactor Demo
Query Demo
Infinite Query
Result Types Demo
Metadata Reactor Demo
Candid Parser
Vite Plugin Demo
Vite Environment Variables
Codegen in Action
TanStack Router
TanStack Form Demo
Next.js Integration
Multiple Canisters
ckBTC Wallet
Custom Provider
Codec Demo
TypeScript Demo
API Reference
Overview
Classes
CallError
CanisterError
ClientManager
DisplayCodecVisitor
DisplayReactor
Reactor
ValidationError
Functions
allowsEnvRootKey
createNullVariant
createPollingStrategy
createVariant
didToDisplayCodec
didToDisplayCodecs
didTypeFromArray
extractOkResult
formatHexDisplay
fromZodSchema
generateKey
getNetworkByHostname
getProcessEnvNetwork
getVariantKey
getVariantKeyValue
getVariantValue
getVariantValueByKey
hexToUint8Array
isCallError
isCanisterError
isDev
isInLocalOrDevelopment
isKeyMatchVariant
isMainnetHost
isNullish
isRetryableReactorError
isValidationError
jsonToString
nonNullish
pinPollingIdentity
processQueryCallResponse
processUpdateCallResponse
reactorRetry
toHashableKeySegment
toReactorQueryData
transformArgsWithCodec
transformResultWithCodec
uint8ArrayToHex
Interfaces
ActorDisplayCodec
ActorMethodCodecs
AgentState
ApiError
ClientManagerParameters
DefaultActorType
DisplayReactorParameters
PollingConfig
ReactorCallParams
ReactorParameters
ReactorQueryParams
TransformArgsRegistry
TransformReturnRegistry
UpdateAgentParameters
ValidationIssue
Type Aliases
ActorMethodParameters
ActorMethodReturnType
ActorMethodType
ArgsType
AsDisplayArgs
BaseActor
BlobType
CandidKeyValue
CandidVariant
CandidVariantKey
CandidVariantToIntersection
CandidVariantValue
CanisterId
DisplayCodec
DisplayCommonType
DisplayOf
DisplayResultOf
DisplayValidator
ErrResult
FunctionName
FunctionType
IsBlobType
IsCandidVariant
IsOkErrResultType
IsOptionalType
NullishType
OkResult
ReactorArgs
ReactorQueryData
ReactorReturnErr
ReactorReturnOk
TransformKey
UnionToTuple
UnwrapOkErrResult
ValidationResult
Validator
Variables
IC_HOST_NETWORK_URI
LOCAL_HOST_NETWORK_URI
LOCAL_HOSTS
REMOTE_HOSTS
VERSION
Packages
Overview
Runtime
@ic-reactor/react
Overview
React Setup
createActorHooks
createAuthHooks
Reactor Hooks
Factory Functions
@ic-reactor/core
Overview
ClientManager
Reactor
DisplayReactor
Validation
@ic-reactor/candid
Overview
CandidReactor
CandidDisplayReactor
MetadataReactor
MetadataDisplayReactor
CandidAdapter
CandidFormVisitor
@ic-reactor/parser
Overview
Metadata Tags
API Reference
Tooling
@ic-reactor/cli
@ic-reactor/vite-plugin
@ic-reactor/codegen
Project
Contributing
GitHub
Select theme
Dark
Light
Auto
CanisterId
Copy Markdown
Open
Open in ChatGPT
Open in Claude
View in Markdown
CanisterId
=
string
|
Principal
Defined in:
types/reactor.ts:32
