API Reference
Classes
Section titled “Classes”- ClientManager
- DisplayReactor
- DisplayCodecVisitor
- CallError
- CanisterError
- ValidationError
- Reactor
- AuthenticationManager
- IdentityAttributesManager
Interfaces
Section titled “Interfaces”- ActorDisplayCodec
- ApiError
- ValidationIssue
- ClientManagerParameters
- AgentState
- UpdateAgentParameters
- DisplayReactorParameters
- DefaultActorType
- ReactorParameters
- TransformArgsRegistry
- TransformReturnRegistry
- ActorMethodCodecs
- ReactorQueryParams
- ReactorCallParams
- PollingConfig
- AuthenticationManagerParameters
- UseIdentityAttributesReturn
- SignedIdentityAttributes
- IdentityAttributeRequest
- IdentityAttributeValues
- IdentityAttributeResult
- AuthClientStorageLike
- AuthClientIdleOptions
- AuthenticationClientOptions
- AuthClientSignInOptions
- AuthenticationSignInOptions
- RequestIdentityAttributesParameters
- RequestOpenIdIdentityAttributesParameters
- AuthClientLike
- AuthState
- InfiniteQueryConfig
- UseInfiniteQueryWithSelect
- InfiniteQueryResult
- SuspenseInfiniteQueryConfig
- UseSuspenseInfiniteQueryWithSelect
- SuspenseInfiniteQueryResult
- DefineReactorSharedParameters
- DefineReactorParameters
- DefineDisplayReactorParameters
- UseAuthReturn
- CreateAuthHooksReturn
- UseReactorInfiniteQueryParameters
- UseReactorMethodParameters
- UseReactorMethodResult
- UseReactorMutationParameters
- UseReactorQueryParameters
- UseReactorSuspenseInfiniteQueryParameters
- UseReactorSuspenseQueryParameters
- BaseQueryConfig
- UseQueryWithSelect
- UseSuspenseQueryWithSelect
- BaseQueryResult
- QueryResult
- SuspenseQueryResult
- MutationConfig
- MutationHookOptions
- MutationResult
- MapValidationErrorsOptions
Type Aliases
Section titled “Type Aliases”- BlobType
- NullishType
- DisplayCommonType
- DisplayOf
- DisplayResultOf
- DisplayCodec
- ValidationResult
- Validator
- DisplayValidator
- BaseActor
- FunctionName
- FunctionType
- CanisterId
- ActorMethodParameters
- ActorMethodReturnType
- ActorMethodType
- ArgsType
- AsDisplayArgs
- TransformKey
- ReactorArgs
- ReactorReturnOk
- ReactorQueryData
- ReactorReturnErr
- UnwrapOkErrResult
- OkResult
- ErrResult
- IsOkErrResultType
- UnionToTuple
- IsBlobType
- IsOptionalType
- IsCandidVariant
- CandidVariantToIntersection
- CandidVariantKey
- CandidVariantValue
- CandidVariant
- CandidKeyValue
- IdentityAttributeNonce
- IdentityAttributeOpenIdProvider
- AuthClientKeyType
- ActorHooks
- InfiniteQueryPageData
- InfiniteQueryError
- InfiniteQueryFactoryConfig
- SuspenseInfiniteQueryPageData
- SuspenseInfiniteQueryError
- SuspenseInfiniteQueryFactoryConfig
- DefineReactorResult
- UseActorInfiniteQueryParameters
- UseReactorInfiniteQueryResult
- UseActorMethodParameters
- UseActorMutationParameters
- UseReactorMutationResult
- UseActorQueryParameters
- UseReactorQueryResult
- UseActorSuspenseInfiniteQueryParameters
- UseReactorSuspenseInfiniteQueryResult
- UseActorSuspenseQueryParameters
- UseReactorSuspenseQueryResult
- NoInfer
- QueryFnData
- QueryError
- QueryConfig
- SuspenseQueryConfig
- QueryFactoryConfig
- SuspenseQueryFactoryConfig
- MutationFactoryConfig
- FieldErrors
- FieldErrorsMultiple
Variables
Section titled “Variables”- REMOTE_HOSTS
- LOCAL_HOSTS
- IC_HOST_NETWORK_URI
- LOCAL_HOST_NETWORK_URI
- VERSION
- IC_INTERNET_IDENTITY_PROVIDER
- INTERNET_IDENTITY_PROVIDER_ENV_KEY
- LOCAL_INTERNET_IDENTITY_CANISTER_ID
- LOCAL_INTERNET_IDENTITY_PROVIDER
- IDENTITY_ATTRIBUTES_PROVIDER
IDENTITY_ATTRIBUTES_BETA_PROVIDER
Functions
Section titled “Functions”- didToDisplayCodec
- didToDisplayCodecs
- transformArgsWithCodec
- transformResultWithCodec
- didTypeFromArray
- isCanisterError
- isCallError
- isValidationError
- isRetryableReactorError
- reactorRetry
- processQueryCallResponse
- pinPollingIdentity
- processUpdateCallResponse
- createNullVariant
- createVariant
- getVariantKeyValue
- getVariantKey
- getVariantValue
- getVariantValueByKey
- isKeyMatchVariant
- generateKey
- toHashableKeySegment
- isInLocalOrDevelopment
- getProcessEnvNetwork
- isDev
- allowsEnvRootKey
- isMainnetHost
- getNetworkByHostname
- extractOkResult
- isNullish
- nonNullish
- uint8ArrayToHex
- hexToUint8Array
- formatHexDisplay
- jsonToString
- createPollingStrategy
- toReactorQueryData
- fromZodSchema
- localInternetIdentityProvider
- createIdentityAttributeHooks
- identityAttributeKeys
- normalizeOpenIdProvider
- resolveIdentityAttributeKeys
- decodeIdentityAttributeValues
- normalizeSignedIdentityAttributes
- createActorHooks
- createInfiniteQuery
- createInfiniteQueryFactory
- createMutation
- createQuery
- createQueryFactory
- createSuspenseInfiniteQuery
- createSuspenseInfiniteQueryFactory
- createSuspenseQuery
- createSuspenseQueryFactory
- defineReactor
- createAuthHooks
- useReactorInfiniteQuery
- useActorMethod
- createActorMethodHooks
- useReactorMutation
- useReactorQuery
- useReactorSuspenseInfiniteQuery
- useReactorSuspenseQuery
- mapValidationErrors
- getFieldError
- getFieldErrors
- extractValidationErrors
- handleValidationError
References
Section titled “References”useReactorMethod
Section titled “useReactorMethod”Renames and re-exports useActorMethod
UseActorQueryResult
Section titled “UseActorQueryResult”Renames and re-exports UseReactorQueryResult
UseActorMutationResult
Section titled “UseActorMutationResult”Renames and re-exports UseReactorMutationResult
UseActorSuspenseQueryResult
Section titled “UseActorSuspenseQueryResult”Renames and re-exports UseReactorSuspenseQueryResult
UseActorInfiniteQueryResult
Section titled “UseActorInfiniteQueryResult”Renames and re-exports UseReactorInfiniteQueryResult
UseActorSuspenseInfiniteQueryResult
Section titled “UseActorSuspenseInfiniteQueryResult”Renames and re-exports UseReactorSuspenseInfiniteQueryResult
UseActorMethodResult
Section titled “UseActorMethodResult”Renames and re-exports UseReactorMethodResult