From eee24b2a2a8795bb703edc141ee4e5d4f7dfb733 Mon Sep 17 00:00:00 2001 From: b3hr4d Date: Fri, 23 Feb 2024 09:58:03 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20B3Pay/ic?= =?UTF-8?q?-reactor@55186271400056b4ea251067e0fec87104385da9=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/core.classes.ActorManager.html | 6 +++--- classes/core.classes.AgentManager.html | 6 +++--- classes/core.classes.CandidAdapter.html | 6 +++--- classes/core.types.AuthClient.html | 2 +- classes/core.types.HttpAgent.html | 2 +- classes/core.types.IDL.BoolClass.html | 2 +- classes/core.types.IDL.ConstructType.html | 2 +- classes/core.types.IDL.EmptyClass.html | 2 +- classes/core.types.IDL.FixedIntClass.html | 2 +- classes/core.types.IDL.FixedNatClass.html | 2 +- classes/core.types.IDL.FloatClass.html | 2 +- classes/core.types.IDL.FuncClass.html | 2 +- classes/core.types.IDL.IntClass.html | 2 +- classes/core.types.IDL.NatClass.html | 2 +- classes/core.types.IDL.NullClass.html | 2 +- classes/core.types.IDL.OptClass.html | 2 +- classes/core.types.IDL.PrimitiveType.html | 2 +- classes/core.types.IDL.PrincipalClass.html | 2 +- classes/core.types.IDL.RecClass.html | 2 +- classes/core.types.IDL.RecordClass.html | 2 +- classes/core.types.IDL.ReservedClass.html | 2 +- classes/core.types.IDL.ServiceClass.html | 2 +- classes/core.types.IDL.TextClass.html | 2 +- classes/core.types.IDL.TupleClass.html | 2 +- classes/core.types.IDL.Type.html | 2 +- classes/core.types.IDL.UnknownClass.html | 2 +- classes/core.types.IDL.VariantClass.html | 2 +- classes/core.types.IDL.VecClass.html | 2 +- classes/core.types.IDL.Visitor.html | 2 +- classes/core.types.Principal.html | 2 +- classes/react.types.ActorManager.html | 2 +- classes/react.types.AgentManager.html | 2 +- classes/react.types.AuthClient.html | 2 +- classes/react.types.HttpAgent.html | 2 +- classes/react.types.IDL.BoolClass.html | 2 +- classes/react.types.IDL.ConstructType.html | 2 +- classes/react.types.IDL.EmptyClass.html | 2 +- classes/react.types.IDL.FixedIntClass.html | 2 +- classes/react.types.IDL.FixedNatClass.html | 2 +- classes/react.types.IDL.FloatClass.html | 2 +- classes/react.types.IDL.FuncClass.html | 2 +- classes/react.types.IDL.IntClass.html | 2 +- classes/react.types.IDL.NatClass.html | 2 +- classes/react.types.IDL.NullClass.html | 2 +- classes/react.types.IDL.OptClass.html | 2 +- classes/react.types.IDL.PrimitiveType.html | 2 +- classes/react.types.IDL.PrincipalClass.html | 2 +- classes/react.types.IDL.RecClass.html | 2 +- classes/react.types.IDL.RecordClass.html | 2 +- classes/react.types.IDL.ReservedClass.html | 2 +- classes/react.types.IDL.ServiceClass.html | 2 +- classes/react.types.IDL.TextClass.html | 2 +- classes/react.types.IDL.TupleClass.html | 2 +- classes/react.types.IDL.Type.html | 2 +- classes/react.types.IDL.UnknownClass.html | 2 +- classes/react.types.IDL.VariantClass.html | 2 +- classes/react.types.IDL.VecClass.html | 2 +- classes/react.types.IDL.Visitor.html | 2 +- classes/react.types.Principal.html | 2 +- classes/visitor.VisitDetails.html | 6 +++--- classes/visitor.VisitFields.html | 6 +++--- classes/visitor.VisitRandomArgs.html | 6 +++--- classes/visitor.VisitRandomResponse.html | 6 +++--- classes/visitor.VisitTransform.html | 6 +++--- classes/visitor.VisitTransformTable.html | 6 +++--- functions/core.createActorManager.html | 4 ++-- functions/core.createAgentManager.html | 4 ++-- functions/core.createCandidAdapter.html | 4 ++-- functions/core.createReactorCore.html | 4 ++-- functions/core.createReactorStore.html | 4 ++-- functions/core.tools.createStoreWithOptionalDevtools.html | 4 ++-- functions/core.tools.generateActorHash.html | 4 ++-- functions/core.tools.generateHash.html | 4 ++-- functions/core.tools.generateRequestHash.html | 4 ++-- functions/core.tools.isInLocalOrDevelopment.html | 4 ++-- functions/core.tools.jsonToString.html | 4 ++-- functions/core.tools.stringToHash.html | 4 ++-- functions/core.types.IDL.Func.html | 2 +- functions/core.types.IDL.Opt.html | 2 +- functions/core.types.IDL.Rec.html | 2 +- functions/core.types.IDL.Record.html | 2 +- functions/core.types.IDL.Service.html | 2 +- functions/core.types.IDL.Tuple.html | 2 +- functions/core.types.IDL.Variant.html | 2 +- functions/core.types.IDL.Vec.html | 2 +- functions/core.types.IDL.decode.html | 2 +- functions/core.types.IDL.encode.html | 2 +- functions/react.ActorProvider.html | 4 ++-- functions/react.AgentProvider.html | 4 ++-- functions/react.core.createActorManager.html | 2 +- functions/react.core.createAgentManager.html | 2 +- functions/react.core.createCandidAdapter.html | 2 +- functions/react.core.createReactorStore.html | 2 +- functions/react.createActorContext.html | 4 ++-- functions/react.createAgentContext.html | 4 ++-- functions/react.createReactor.html | 4 ++-- functions/react.helpers.actorHooks.html | 4 ++-- functions/react.helpers.agentHooks.html | 4 ++-- functions/react.helpers.authHooks.html | 4 ++-- functions/react.helpers.extractActorContext.html | 4 ++-- functions/react.helpers.extractAgentContext.html | 4 ++-- functions/react.types.IDL.Func.html | 2 +- functions/react.types.IDL.Opt.html | 2 +- functions/react.types.IDL.Rec.html | 2 +- functions/react.types.IDL.Record.html | 2 +- functions/react.types.IDL.Service.html | 2 +- functions/react.types.IDL.Tuple.html | 2 +- functions/react.types.IDL.Variant.html | 2 +- functions/react.types.IDL.Vec.html | 2 +- functions/react.types.IDL.decode.html | 2 +- functions/react.types.IDL.encode.html | 2 +- functions/react.useActor.html | 4 ++-- functions/react.useActorState.html | 4 ++-- functions/react.useAgent.html | 4 ++-- functions/react.useAgentManager.html | 4 ++-- functions/react.useAgentState.html | 4 ++-- functions/react.useAuth.html | 4 ++-- functions/react.useAuthState.html | 4 ++-- functions/react.useQueryCall.html | 4 ++-- functions/react.useUpdateCall.html | 4 ++-- functions/react.useUserPrincipal.html | 4 ++-- functions/react.useVisitMethod.html | 4 ++-- functions/visitor.helper.convertStringToNumber.html | 4 ++-- functions/visitor.helper.extractAndSortArgs.html | 4 ++-- functions/visitor.helper.isImage.html | 4 ++-- functions/visitor.helper.isQuery.html | 4 ++-- functions/visitor.helper.isUrl.html | 4 ++-- functions/visitor.helper.validateError.html | 4 ++-- functions/visitor.helper.validateNumberError.html | 4 ++-- hierarchy.html | 2 +- index.html | 2 +- interfaces/core.types.ActorManagerParameters.html | 6 +++--- interfaces/core.types.ActorMethod.html | 2 +- interfaces/core.types.ActorMethodState.html | 4 ++-- interfaces/core.types.AgentManagerParameters.html | 6 +++--- interfaces/core.types.AgentState.html | 6 +++--- interfaces/core.types.AuthClientLoginOptions.html | 2 +- interfaces/core.types.AuthState.html | 6 +++--- interfaces/core.types.CandidAdapterParameters.html | 6 +++--- interfaces/core.types.CandidDefenition.html | 6 +++--- interfaces/core.types.CreateReactorCoreParameters.html | 6 +++--- interfaces/core.types.CreateReactorCoreReturnType.html | 6 +++--- interfaces/core.types.CreateReactorStoreParameters.html | 6 +++--- interfaces/core.types.DefaultActorType.html | 4 ++-- interfaces/core.types.HttpAgentOptions.html | 2 +- interfaces/core.types.Identity.html | 2 +- interfaces/core.types.UpdateAgentParameters.html | 6 +++--- interfaces/react.types.ActorHooksReturnType.html | 6 +++--- interfaces/react.types.ActorManagerParameters.html | 2 +- interfaces/react.types.ActorMethod.html | 2 +- interfaces/react.types.ActorMethodState.html | 2 +- interfaces/react.types.ActorProviderProps.html | 6 +++--- interfaces/react.types.AgentContext.html | 6 +++--- interfaces/react.types.AgentHooksReturnType.html | 6 +++--- interfaces/react.types.AgentManagerParameters.html | 2 +- interfaces/react.types.AgentProviderProps.html | 6 +++--- interfaces/react.types.AgentState.html | 2 +- interfaces/react.types.AuthClientLoginOptions.html | 2 +- interfaces/react.types.AuthHooksReturnType.html | 6 +++--- interfaces/react.types.AuthState.html | 2 +- interfaces/react.types.CandidAdapterParameters.html | 2 +- interfaces/react.types.CandidDefenition.html | 2 +- interfaces/react.types.CreateActorContextParameters.html | 6 +++--- interfaces/react.types.CreateActorContextReturnType.html | 6 +++--- interfaces/react.types.CreateAgentContextReturnType.html | 6 +++--- interfaces/react.types.CreateReactorCoreParameters.html | 2 +- interfaces/react.types.CreateReactorCoreReturnType.html | 2 +- interfaces/react.types.CreateReactorParameters.html | 4 ++-- interfaces/react.types.CreateReactorReturnType.html | 6 +++--- interfaces/react.types.CreateReactorStoreParameters.html | 2 +- interfaces/react.types.DefaultActorType.html | 2 +- interfaces/react.types.HttpAgentOptions.html | 2 +- interfaces/react.types.Identity.html | 2 +- interfaces/react.types.UpdateAgentParameters.html | 2 +- interfaces/react.types.UseActorParameters.html | 6 +++--- interfaces/react.types.UseActorReturn.html | 6 +++--- interfaces/react.types.UseActorState.html | 6 +++--- interfaces/react.types.UseAuthParameters.html | 6 +++--- interfaces/react.types.UseAuthReturnType.html | 6 +++--- interfaces/react.types.UseMethodCallReturnType.html | 6 +++--- interfaces/react.types.UseQueryCallParameters.html | 6 +++--- interfaces/react.types.UseUpdateCallParameters.html | 6 +++--- interfaces/visitor.types.DefaultField.html | 6 +++--- interfaces/visitor.types.DynamicDataArgs.html | 6 +++--- interfaces/visitor.types.ExtractedServiceDetails.html | 6 +++--- interfaces/visitor.types.ExtractedServiceFields.html | 6 +++--- interfaces/visitor.types.ExtractedServiceResults.html | 6 +++--- interfaces/visitor.types.FieldDetails.html | 6 +++--- interfaces/visitor.types.FieldDetailsWithChild.html | 6 +++--- interfaces/visitor.types.InputDetails.html | 6 +++--- interfaces/visitor.types.InputField.html | 6 +++--- interfaces/visitor.types.MethodFields.html | 6 +++--- interfaces/visitor.types.NumberField.html | 6 +++--- interfaces/visitor.types.OptionalFields.html | 6 +++--- interfaces/visitor.types.PrincipalField.html | 6 +++--- interfaces/visitor.types.RecordFields.html | 6 +++--- interfaces/visitor.types.RecursiveFields.html | 6 +++--- interfaces/visitor.types.ResultArrayData.html | 6 +++--- interfaces/visitor.types.ResultRecordData.html | 6 +++--- interfaces/visitor.types.TupleFields.html | 6 +++--- interfaces/visitor.types.VariantFields.html | 6 +++--- interfaces/visitor.types.VectorFields.html | 6 +++--- modules/core.classes.html | 4 ++-- modules/core.html | 2 +- modules/core.tools.html | 4 ++-- modules/core.types.IDL.html | 2 +- modules/core.types.html | 4 ++-- modules/react.core.html | 4 ++-- modules/react.helpers.html | 4 ++-- modules/react.html | 2 +- modules/react.types.IDL.html | 2 +- modules/react.types.html | 4 ++-- modules/visitor.helper.html | 4 ++-- modules/visitor.html | 2 +- modules/visitor.types.html | 4 ++-- types/core.types.ActorCallFunction.html | 4 ++-- types/core.types.ActorGetStateFunction.html | 4 ++-- types/core.types.ActorMethodCall.html | 4 ++-- types/core.types.ActorMethodParameters.html | 4 ++-- types/core.types.ActorMethodReturnType.html | 4 ++-- types/core.types.ActorMethodStates.html | 4 ++-- types/core.types.ActorQuery.html | 4 ++-- types/core.types.ActorQueryParameters.html | 4 ++-- types/core.types.ActorQueryReturnType.html | 4 ++-- types/core.types.ActorState.html | 4 ++-- types/core.types.ActorStore.html | 4 ++-- types/core.types.ActorSubclass.html | 2 +- types/core.types.ActorSubscribeFunction.html | 4 ++-- types/core.types.ActorUpdate.html | 4 ++-- types/core.types.ActorUpdateParameters.html | 4 ++-- types/core.types.ActorUpdateReturnType.html | 4 ++-- types/core.types.AgentStore.html | 4 ++-- types/core.types.AuthStore.html | 4 ++-- types/core.types.BaseActor.html | 4 ++-- types/core.types.CallActorMethod.html | 4 ++-- types/core.types.CanisterId.html | 4 ++-- types/core.types.FunctionName.html | 4 ++-- types/core.types.FunctionType.html | 4 ++-- types/core.types.IDL.InterfaceFactory.html | 2 +- types/core.types.VisitService.html | 4 ++-- types/core.types.VisitorType.html | 4 ++-- types/react.types.ActorCallFunction.html | 2 +- types/react.types.ActorCallState.html | 4 ++-- types/react.types.ActorGetStateFunction.html | 2 +- types/react.types.ActorMethodCall.html | 2 +- types/react.types.ActorMethodParameters.html | 2 +- types/react.types.ActorMethodReturnType.html | 2 +- types/react.types.ActorMethodStates.html | 2 +- types/react.types.ActorQuery.html | 2 +- types/react.types.ActorQueryParameters.html | 2 +- types/react.types.ActorQueryReturnType.html | 2 +- types/react.types.ActorState.html | 2 +- types/react.types.ActorStore.html | 2 +- types/react.types.ActorSubclass.html | 2 +- types/react.types.ActorSubscribeFunction.html | 2 +- types/react.types.ActorUpdate.html | 2 +- types/react.types.ActorUpdateParameters.html | 2 +- types/react.types.ActorUpdateReturnType.html | 2 +- types/react.types.AgentStore.html | 2 +- types/react.types.AuthStore.html | 2 +- types/react.types.BaseActor.html | 2 +- types/react.types.CallActorMethod.html | 2 +- types/react.types.CanisterId.html | 2 +- types/react.types.FunctionName.html | 2 +- types/react.types.FunctionType.html | 2 +- types/react.types.IDL.InterfaceFactory.html | 2 +- types/react.types.LoginParameters.html | 4 ++-- types/react.types.LoginState.html | 4 ++-- types/react.types.LogoutParameters.html | 4 ++-- types/react.types.UseMethodCall.html | 4 ++-- types/react.types.UseMethodCallParameters.html | 4 ++-- types/react.types.UseQueryCall.html | 4 ++-- types/react.types.UseUpdateCall.html | 4 ++-- types/react.types.UseVisitMethod.html | 4 ++-- types/react.types.VisitService.html | 2 +- types/react.types.VisitorType.html | 2 +- types/visitor.types.AllFieldTypes.html | 4 ++-- types/visitor.types.AllNumberTypes.html | 4 ++-- types/visitor.types.DynamicFieldType.html | 4 ++-- types/visitor.types.DynamicFieldTypeByClass.html | 4 ++-- types/visitor.types.ExtraInputFormFields.html | 4 ++-- types/visitor.types.FieldType.html | 4 ++-- types/visitor.types.FieldTypeFromIDLType.html | 4 ++-- types/visitor.types.FunctionCategory.html | 4 ++-- types/visitor.types.MethodDefaultValues.html | 4 ++-- types/visitor.types.MethodDetails.html | 4 ++-- types/visitor.types.MethodResult.html | 4 ++-- types/visitor.types.MethodResultValue.html | 4 ++-- types/visitor.types.OtherDetails.html | 4 ++-- types/visitor.types.ReturnDataType.html | 4 ++-- types/visitor.types.ServiceDefaultValues.html | 4 ++-- types/visitor.types.ServiceDetails.html | 4 ++-- types/visitor.types.ServiceFields.html | 4 ++-- types/visitor.types.ServiceResult.html | 4 ++-- variables/core.tools.DEFAULT_IC_DIDJS_ID.html | 4 ++-- variables/core.tools.DEFAULT_LOCAL_DIDJS_ID.html | 4 ++-- variables/core.tools.IC_HOST_NETWORK_URI.html | 4 ++-- variables/core.tools.IC_INTERNET_IDENTITY_PROVIDER.html | 4 ++-- variables/core.tools.LOCAL_HOST_NETWORK_URI.html | 4 ++-- variables/core.tools.LOCAL_INTERNET_IDENTITY_PROVIDER.html | 4 ++-- variables/core.types.IDL.Bool.html | 2 +- variables/core.types.IDL.Empty.html | 2 +- variables/core.types.IDL.Float32.html | 2 +- variables/core.types.IDL.Float64.html | 2 +- variables/core.types.IDL.Int.html | 2 +- variables/core.types.IDL.Int16.html | 2 +- variables/core.types.IDL.Int32.html | 2 +- variables/core.types.IDL.Int64.html | 2 +- variables/core.types.IDL.Int8.html | 2 +- variables/core.types.IDL.Nat.html | 2 +- variables/core.types.IDL.Nat16.html | 2 +- variables/core.types.IDL.Nat32.html | 2 +- variables/core.types.IDL.Nat64.html | 2 +- variables/core.types.IDL.Nat8.html | 2 +- variables/core.types.IDL.Null.html | 2 +- variables/core.types.IDL.Principal.html | 2 +- variables/core.types.IDL.Reserved.html | 2 +- variables/core.types.IDL.Text.html | 2 +- variables/core.types.IDL.Unknown.html | 2 +- variables/react.types.IDL.Bool.html | 2 +- variables/react.types.IDL.Empty.html | 2 +- variables/react.types.IDL.Float32.html | 2 +- variables/react.types.IDL.Float64.html | 2 +- variables/react.types.IDL.Int.html | 2 +- variables/react.types.IDL.Int16.html | 2 +- variables/react.types.IDL.Int32.html | 2 +- variables/react.types.IDL.Int64.html | 2 +- variables/react.types.IDL.Int8.html | 2 +- variables/react.types.IDL.Nat.html | 2 +- variables/react.types.IDL.Nat16.html | 2 +- variables/react.types.IDL.Nat32.html | 2 +- variables/react.types.IDL.Nat64.html | 2 +- variables/react.types.IDL.Nat8.html | 2 +- variables/react.types.IDL.Null.html | 2 +- variables/react.types.IDL.Principal.html | 2 +- variables/react.types.IDL.Reserved.html | 2 +- variables/react.types.IDL.Text.html | 2 +- variables/react.types.IDL.Unknown.html | 2 +- 338 files changed, 560 insertions(+), 560 deletions(-) diff --git a/classes/core.classes.ActorManager.html b/classes/core.classes.ActorManager.html index a4458a3a93..4064573945 100644 --- a/classes/core.classes.ActorManager.html +++ b/classes/core.classes.ActorManager.html @@ -1,5 +1,5 @@ ActorManager | ic-reactor -

Class ActorManager<A>

Type Parameters

Constructors

constructor +

Class ActorManager<A>

Type Parameters

Constructors

constructor

Properties

_actor _idlFactory _agentManager @@ -18,10 +18,10 @@ initializeActor callMethod getActor -

Constructors

constructor

Properties

Private _actor

_actor: null | A = null

Private _idlFactory

_idlFactory: types.IDL.InterfaceFactory

Private _agentManager

_agentManager: classes.AgentManager

canisterId

canisterId: types.CanisterId

actorStore

actorStore: types.ActorStore<A>

visitFunction

visitFunction: types.VisitService<A>

Private initialState

initialState: types.ActorState<A> = ...

getState

getState: (() => types.ActorState<A>) = ...

Type declaration

subscribeActorState

subscribeActorState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

setState

setState: ((partial, replace?) => void) = ...

Type declaration

Accessors

agentManager

Methods

Private updateState

updateMethodState

initialize

extractService

Private initializeActor

callMethod

getActor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Properties

Private _actor

_actor: null | A = null

Private _idlFactory

_idlFactory: types.IDL.InterfaceFactory

Private _agentManager

_agentManager: classes.AgentManager

canisterId

canisterId: types.CanisterId

actorStore

actorStore: types.ActorStore<A>

visitFunction

visitFunction: types.VisitService<A>

Private initialState

initialState: types.ActorState<A> = ...

getState

getState: (() => types.ActorState<A>) = ...

Type declaration

subscribeActorState

subscribeActorState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

setState

setState: ((partial, replace?) => void) = ...

Type declaration

Accessors

agentManager

Methods

Private updateState

updateMethodState

initialize

extractService

Private initializeActor

callMethod

getActor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Class AgentManager

Hierarchy (view full)

Constructors

constructor +

Class AgentManager

Hierarchy (view full)

Constructors

constructor

Properties

_agent _auth _subscribers @@ -24,10 +24,10 @@ getAuth getIdentity getPrincipal -

Constructors

constructor

Properties

Private _agent

_agent: types.HttpAgent

Private _auth

_auth: null | types.AuthClient = null

Private _subscribers

_subscribers: ((agent) => void)[] = []

Type declaration

agentStore

agentStore: types.AgentStore

authStore

authStore: types.AuthStore

isLocalEnv

isLocalEnv: boolean

Private initialAgentState

initialAgentState: types.AgentState = ...

Private initialAuthState

initialAuthState: types.AuthState = ...

getAgentState

getAgentState: (() => types.AgentState) = ...

Type declaration

subscribeAgentState

subscribeAgentState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

getAuthState

getAuthState: (() => types.AuthState) = ...

Type declaration

subscribeAuthState

subscribeAuthState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Methods

Private updateAgentState

Private updateAuthState

Private initializeAgent

subscribeAgent

unsubscribeAgent

Private notifySubscribers

updateAgent

authenticate

getAgent

getAuth

getIdentity

getPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Properties

Private _agent

_agent: types.HttpAgent

Private _auth

_auth: null | types.AuthClient = null

Private _subscribers

_subscribers: ((agent) => void)[] = []

Type declaration

agentStore

agentStore: types.AgentStore

authStore

authStore: types.AuthStore

isLocalEnv

isLocalEnv: boolean

Private initialAgentState

initialAgentState: types.AgentState = ...

Private initialAuthState

initialAuthState: types.AuthState = ...

getAgentState

getAgentState: (() => types.AgentState) = ...

Type declaration

subscribeAgentState

subscribeAgentState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

getAuthState

getAuthState: (() => types.AuthState) = ...

Type declaration

subscribeAuthState

subscribeAuthState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Methods

Private updateAgentState

Private updateAuthState

Private initializeAgent

subscribeAgent

unsubscribeAgent

Private notifySubscribers

updateAgent

authenticate

getAgent

getAuth

getIdentity

getPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Class CandidAdapter

Constructors

constructor +

Class CandidAdapter

Constructors

constructor

Properties

agent didjsCanisterId

Methods

getDefaultDidJsId @@ -7,10 +7,10 @@ getFromMetadata getFromTmpHack didTojs -

Constructors

constructor

Properties

agent

agent: types.HttpAgent

didjsCanisterId

didjsCanisterId: string

Methods

Private getDefaultDidJsId

getCandidDefinition

getFromMetadata

getFromTmpHack

didTojs

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Properties

agent

agent: types.HttpAgent

didjsCanisterId

didjsCanisterId: string

Methods

Private getDefaultDidJsId

getCandidDefinition

getFromMetadata

getFromTmpHack

didTojs

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class VisitDetails<A>

Visit the candid file and extract the details. It returns the extracted service details.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

counter visitedRecursive visitInt @@ -28,10 +28,10 @@ visitText visitNumber visitService -

Constructors

constructor

Properties

counter

counter: number = 0

Private visitedRecursive

visitedRecursive: Record<string, true> = {}

visitInt

visitInt: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitNat

visitNat: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitFloat

visitFloat: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitFixedInt

visitFixedInt: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitFixedNat

visitFixedNat: (<T>(t, __label) => InputDetails) = ...

Type declaration

Methods

visitPrimitive

visitEmpty

visitReserved

visitConstruct

visitFunc

visitRecord

visitVariant

visitTuple

visitRec

visitOpt

visitVec

Private visiGenericType

visitType

visitPrincipal

visitBool

visitNull

visitText

visitNumber

visitService

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Properties

counter

counter: number = 0

Private visitedRecursive

visitedRecursive: Record<string, true> = {}

visitInt

visitInt: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitNat

visitNat: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitFloat

visitFloat: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitFixedInt

visitFixedInt: (<T>(t, __label) => InputDetails) = ...

Type declaration

visitFixedNat

visitFixedNat: (<T>(t, __label) => InputDetails) = ...

Type declaration

Methods

visitPrimitive

visitEmpty

visitReserved

visitConstruct

visitFunc

visitRecord

visitVariant

visitTuple

visitRec

visitOpt

visitVec

Private visiGenericType

visitType

visitPrincipal

visitBool

visitNull

visitText

visitNumber

visitService

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class VisitFields<A, M>

Visit the candid file and extract the fields. It returns the extracted service fields.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

visitPrimitive visitEmpty visitReserved @@ -25,10 +25,10 @@ visitFixedInt visitFixedNat visitService -

Constructors

constructor

Methods

visitPrimitive

visitEmpty

visitReserved

visitConstruct

visitFunc

visitRecord

visitVariant

visitTuple

visitRec

visitOpt

visitVec

visitType

visitPrincipal

visitBool

visitNull

visitText

visitNumber

visitInt

visitNat

visitFloat

visitFixedInt

visitFixedNat

visitService

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Methods

visitPrimitive

visitEmpty

visitReserved

visitConstruct

visitFunc

visitRecord

visitVariant

visitTuple

visitRec

visitOpt

visitVec

visitType

visitPrincipal

visitBool

visitNull

visitText

visitNumber

visitInt

visitNat

visitFloat

visitFixedInt

visitFixedNat

visitService

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class VisitRandomArgs<A>

Visit the candid file and extract the fields. It returns the extracted service fields.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

savedRec

Methods

visitType visitPrimitive @@ -30,10 +30,10 @@ generateBigInteger bytesToHex generateRandomBytes -

Constructors

constructor

Properties

Private savedRec

savedRec: Record<string, unknown> = {}

Methods

visitType

  • visitType<T>(t, data): unknown

  • Type Parameters

    • T

    Parameters

    Returns unknown

visitPrimitive

visitEmpty

  • visitEmpty(t, data): unknown

  • Parameters

    Returns unknown

visitReserved

visitNumber

  • visitNumber<T>(t, data): unknown

  • Type Parameters

    • T

    Parameters

    Returns unknown

visitConstruct

visitService

visitFunc

visitRecord

visitVariant

visitVec

visitOpt

visitTuple

visitRec

visitPrincipal

visitNull

visitBool

visitText

visitFloat

visitInt

visitNat

visitFixedInt

visitFixedNat

Private generateNumber

Private generateBigInteger

Private bytesToHex

Private generateRandomBytes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Properties

Private savedRec

savedRec: Record<string, unknown> = {}

Methods

visitType

  • visitType<T>(t, data): unknown

  • Type Parameters

    • T

    Parameters

    Returns unknown

visitPrimitive

visitEmpty

  • visitEmpty(t, data): unknown

  • Parameters

    Returns unknown

visitReserved

visitNumber

  • visitNumber<T>(t, data): unknown

  • Type Parameters

    • T

    Parameters

    Returns unknown

visitConstruct

visitService

visitFunc

visitRecord

visitVariant

visitVec

visitOpt

visitTuple

visitRec

visitPrincipal

visitNull

visitBool

visitText

visitFloat

visitInt

visitNat

visitFixedInt

visitFixedNat

Private generateNumber

Private generateBigInteger

Private bytesToHex

Private generateRandomBytes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class VisitRandomResponse<A>

Visit the candid file and extract the fields. It returns the extracted service fields.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

savedRec

Methods

visitPrimitive visitEmpty @@ -30,10 +30,10 @@ generateBigInteger bytesToHex generateRandomBytes -

Constructors

constructor

Properties

Private savedRec

savedRec: Record<string, unknown> = {}

Methods

visitPrimitive

visitEmpty

  • visitEmpty(t, data): unknown

  • Parameters

    Returns unknown

visitReserved

visitNumber

  • visitNumber<T>(t, data): unknown

  • Type Parameters

    • T

    Parameters

    Returns unknown

visitConstruct

visitService

visitFunc

visitRecord

visitVariant

visitVec

visitOpt

visitTuple

visitRec

visitType

visitPrincipal

visitNull

visitBool

visitText

visitFloat

visitInt

visitNat

visitFixedInt

visitFixedNat

Private generateNumber

Private generateBigInteger

Private bytesToHex

Private generateRandomBytes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Properties

Private savedRec

savedRec: Record<string, unknown> = {}

Methods

visitPrimitive

visitEmpty

  • visitEmpty(t, data): unknown

  • Parameters

    Returns unknown

visitReserved

visitNumber

  • visitNumber<T>(t, data): unknown

  • Type Parameters

    • T

    Parameters

    Returns unknown

visitConstruct

visitService

visitFunc

visitRecord

visitVariant

visitVec

visitOpt

visitTuple

visitRec

visitType

visitPrincipal

visitNull

visitBool

visitText

visitFloat

visitInt

visitNat

visitFixedInt

visitFixedNat

Private generateNumber

Private generateBigInteger

Private bytesToHex

Private generateRandomBytes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class VisitTransform<A, M>

Visit the candid file and extract the fields. It returns the extracted service fields.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

visitPrimitive visitEmpty visitNull @@ -25,10 +25,10 @@ visitBool visitType visitPrincipal -

Constructors

constructor

Methods

visitPrimitive

  • visitPrimitive<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitEmpty

  • visitEmpty(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitNull

  • visitNull(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitReserved

  • visitReserved(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitConstruct

  • visitConstruct<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitService

  • visitService(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitFunc

visitRec

visitOpt

visitRecord

visitTuple

visitVariant

visitVec

visitNumber

visitText

visitInt

visitNat

visitFloat

visitFixedInt

visitFixedNat

visitBool

visitType

visitPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Methods

visitPrimitive

  • visitPrimitive<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitEmpty

  • visitEmpty(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitNull

  • visitNull(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitReserved

  • visitReserved(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitConstruct

  • visitConstruct<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitService

  • visitService(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitFunc

visitRec

visitOpt

visitRecord

visitTuple

visitVariant

visitVec

visitNumber

visitText

visitInt

visitNat

visitFloat

visitFixedInt

visitFixedNat

visitBool

visitType

visitPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class VisitTransformTable<A, M>

Visit the candid file and extract the fields. It returns the extracted service fields.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

visitPrimitive visitEmpty visitNull @@ -25,10 +25,10 @@ visitBool visitType visitPrincipal -

Constructors

constructor

Methods

visitPrimitive

  • visitPrimitive<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitEmpty

  • visitEmpty(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitNull

  • visitNull(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitReserved

  • visitReserved(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitConstruct

  • visitConstruct<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitService

  • visitService(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitFunc

visitRec

visitOpt

visitRecord

visitTuple

visitVariant

visitVec

visitNumber

visitText

visitInt

visitNat

visitFloat

visitFixedInt

visitFixedNat

visitBool

visitType

visitPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Constructors

constructor

Methods

visitPrimitive

  • visitPrimitive<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitEmpty

  • visitEmpty(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitNull

  • visitNull(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitReserved

  • visitReserved(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitConstruct

  • visitConstruct<T>(t, data): MethodResult<A, M>

  • Type Parameters

    • T

    Parameters

    Returns MethodResult<A, M>

visitService

  • visitService(t, data): MethodResult<A, M>

  • Parameters

    Returns MethodResult<A, M>

visitFunc

visitRec

visitOpt

visitRecord

visitTuple

visitVariant

visitVec

visitNumber

visitText

visitInt

visitNat

visitFloat

visitFixedInt

visitFixedNat

visitBool

visitType

visitPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Function createStoreWithOptionalDevtools

  • createStoreWithOptionalDevtools<T>(initialState, config): WithDevtools<StoreApi<T>>

  • Type Parameters

    • T

    Parameters

    • initialState: T
    • config: StoreParameters

    Returns WithDevtools<StoreApi<T>>

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function createStoreWithOptionalDevtools

  • createStoreWithOptionalDevtools<T>(initialState, config): WithDevtools<StoreApi<T>>

  • Type Parameters

    • T

    Parameters

    • initialState: T
    • config: StoreParameters

    Returns WithDevtools<StoreApi<T>>

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function generateActorHash

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function generateActorHash

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function generateHash

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function generateHash

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function generateRequestHash

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function generateRequestHash

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function isInLocalOrDevelopment

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function isInLocalOrDevelopment

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function jsonToString

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function jsonToString

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function stringToHash

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function stringToHash

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function agentHooks

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function agentHooks

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function authHooks

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function authHooks

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function extractActorContext

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function extractActorContext

Settings

Member Visibility

Theme

Generated using TypeDoc

Function useAgent

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Settings

Member Visibility

Theme

Generated using TypeDoc

Function useAgentManager

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Settings

Member Visibility

Theme

Generated using TypeDoc

Function useAgentState

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Settings

Member Visibility

Theme

Generated using TypeDoc

Function useAuthState

  • useAuthState(): types.AuthState

  • Accesses the current authentication state.

    Returns types.AuthState

    Example

    function AuthStateComponent() {
      const { isAuthenticated, authenticating, identity, error } = useAuthState();

      return (
        <div>
          {authenticating ? 'Authenticating...' : ''}
          {error ? `Error: ${error.message}` : ''}
          {isAuthenticated ? `User ${identity?.getPrincipal()} is authenticated.` : 'User is not authenticated.'}
        </div>
      );
    }
    -

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Settings

Member Visibility

Theme

Generated using TypeDoc

Function useUserPrincipal

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Settings

Member Visibility

Theme

Generated using TypeDoc

Function useVisitMethod

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function convertStringToNumber

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function convertStringToNumber

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function extractAndSortArgs

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function extractAndSortArgs

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function isImage

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function isImage

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function isQuery

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function isQuery

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function isUrl

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function isUrl

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function validateError

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function validateError

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Function validateNumberError

  • validateNumberError(t): ((value) => string | true)

  • Parameters

    Returns ((value) => string | true)

      • (value): string | true

      • Parameters

        • value: string

        Returns string | true

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Function validateNumberError

  • validateNumberError(t): ((value) => string | true)

  • Parameters

    Returns ((value) => string | true)

      • (value): string | true

      • Parameters

        • value: string

        Returns string | true

Settings

Member Visibility

Theme

Generated using TypeDoc

ic-reactor

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Interface ActorManagerParameters

interface ActorManagerParameters {
    agentManager: classes.AgentManager;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
}

Properties

agentManager +

Interface ActorManagerParameters

interface ActorManagerParameters {
    agentManager: classes.AgentManager;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
}

Properties

agentManager idlFactory canisterId withVisitor? withDevtools? initializeOnCreate? -

Properties

agentManager

agentManager: classes.AgentManager

idlFactory

idlFactory: types.IDL.InterfaceFactory

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

agentManager

agentManager: classes.AgentManager

idlFactory

idlFactory: types.IDL.InterfaceFactory

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface ActorMethodState<A, M>

interface ActorMethodState<A, M> {
    [key: string]: {
        data: types.ActorMethodReturnType<A[M]> | undefined;
        loading: boolean;
        error: Error | undefined;
    };
}

Type Parameters

Indexable

[key: string]: {
    data: types.ActorMethodReturnType<A[M]> | undefined;
    loading: boolean;
    error: Error | undefined;
}

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Interface ActorMethodState<A, M>

interface ActorMethodState<A, M> {
    [key: string]: {
        data: types.ActorMethodReturnType<A[M]> | undefined;
        loading: boolean;
        error: Error | undefined;
    };
}

Type Parameters

Indexable

[key: string]: {
    data: types.ActorMethodReturnType<A[M]> | undefined;
    loading: boolean;
    error: Error | undefined;
}

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Interface AgentManagerParameters

interface AgentManagerParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    port?: number;
    isLocalEnv?: boolean;
    withDevtools?: boolean;
}

Hierarchy (view full)

Properties

source? +

Interface AgentManagerParameters

interface AgentManagerParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    port?: number;
    isLocalEnv?: boolean;
    withDevtools?: boolean;
}

Hierarchy (view full)

Properties

source? fetch? fetchOptions? callOptions? @@ -27,10 +27,10 @@

Default

false

Default

true

Optional logToConsole

logToConsole?: boolean

Whether to log to the console. Defaults to false.

-

Optional port

port?: number

Optional isLocalEnv

isLocalEnv?: boolean

Optional withDevtools

withDevtools?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Optional port

port?: number

Optional isLocalEnv

isLocalEnv?: boolean

Optional withDevtools

withDevtools?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface AgentState

interface AgentState {
    initialized: boolean;
    initializing: boolean;
    error: undefined | Error;
}

Properties

initialized +

Interface AgentState

interface AgentState {
    initialized: boolean;
    initializing: boolean;
    error: undefined | Error;
}

Properties

initialized initializing error -

Properties

initialized

initialized: boolean

initializing

initializing: boolean

error

error: undefined | Error

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

initialized

initialized: boolean

initializing

initializing: boolean

error

error: undefined | Error

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface AuthState

interface AuthState {
    identity: null | types.Identity;
    authenticating: boolean;
    authenticated: boolean;
    error: undefined | Error;
}

Properties

identity +

Interface AuthState

interface AuthState {
    identity: null | types.Identity;
    authenticating: boolean;
    authenticated: boolean;
    error: undefined | Error;
}

Properties

identity authenticating authenticated error -

Properties

identity

identity: null | types.Identity

authenticating

authenticating: boolean

authenticated

authenticated: boolean

error

error: undefined | Error

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

identity

identity: null | types.Identity

authenticating

authenticating: boolean

authenticated

authenticated: boolean

error

error: undefined | Error

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CandidAdapterParameters

interface CandidAdapterParameters {
    agentManager?: classes.AgentManager;
    agent?: types.HttpAgent;
    didjsCanisterId?: string;
}

Properties

agentManager? +

Interface CandidAdapterParameters

interface CandidAdapterParameters {
    agentManager?: classes.AgentManager;
    agent?: types.HttpAgent;
    didjsCanisterId?: string;
}

Properties

agentManager? agent? didjsCanisterId? -

Properties

Optional agentManager

agentManager?: classes.AgentManager

Optional agent

agent?: types.HttpAgent

Optional didjsCanisterId

didjsCanisterId?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

Optional agentManager

agentManager?: classes.AgentManager

Optional agent

agent?: types.HttpAgent

Optional didjsCanisterId

didjsCanisterId?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CandidDefenition

interface CandidDefenition {
    idlFactory: types.IDL.InterfaceFactory;
    init: ((__namedParameters) => never[]);
}

Properties

idlFactory +

Interface CandidDefenition

interface CandidDefenition {
    idlFactory: types.IDL.InterfaceFactory;
    init: ((__namedParameters) => never[]);
}

Properties

idlFactory init -

Properties

idlFactory

idlFactory: types.IDL.InterfaceFactory

init

init: ((__namedParameters) => never[])

Type declaration

    • (__namedParameters): never[]

    • Parameters

      • __namedParameters: {
            idl: IDL;
        }

      Returns never[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

idlFactory

idlFactory: types.IDL.InterfaceFactory

init

init: ((__namedParameters) => never[])

Type declaration

    • (__namedParameters): never[]

    • Parameters

      • __namedParameters: {
            idl: IDL;
        }

      Returns never[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateReactorCoreParameters

interface CreateReactorCoreParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    agentManager?: classes.AgentManager;
    isLocalEnv?: boolean;
    port?: number;
    withProcessEnv?: boolean;
}

Hierarchy (view full)

Properties

source? +

Interface CreateReactorCoreParameters

interface CreateReactorCoreParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    agentManager?: classes.AgentManager;
    isLocalEnv?: boolean;
    port?: number;
    withProcessEnv?: boolean;
}

Hierarchy (view full)

Properties

source? fetch? fetchOptions? callOptions? @@ -33,10 +33,10 @@

Default

false

Default

true

Optional logToConsole

logToConsole?: boolean

Whether to log to the console. Defaults to false.

-

idlFactory

idlFactory: types.IDL.InterfaceFactory

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional agentManager

agentManager?: classes.AgentManager

Optional isLocalEnv

isLocalEnv?: boolean

Optional port

port?: number

Optional withProcessEnv

withProcessEnv?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

idlFactory

idlFactory: types.IDL.InterfaceFactory

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional agentManager

agentManager?: classes.AgentManager

Optional isLocalEnv

isLocalEnv?: boolean

Optional port

port?: number

Optional withProcessEnv

withProcessEnv?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateReactorCoreReturnType<A>

interface CreateReactorCoreReturnType<A> {
    canisterId: types.CanisterId;
    actorStore: types.ActorStore<A>;
    visitFunction: types.VisitService<A>;
    agentManager: classes.AgentManager;
    getState: (() => types.ActorState<A>);
    subscribeActorState: ((listener) => (() => void));
    setState: ((partial, replace?) => void);
    agentStore: types.AgentStore;
    authStore: types.AuthStore;
    isLocalEnv: boolean;
    getAgentState: (() => types.AgentState);
    subscribeAgentState: ((listener) => (() => void));
    getAuthState: (() => types.AuthState);
    subscribeAuthState: ((listener) => (() => void));
    login: ((config?) => Promise<void>);
    logout: ((config?) => Promise<void>);
    queryCall: types.ActorQuery<A>;
    updateCall: types.ActorUpdate<A>;
    initialize(options?): Promise<void>;
    extractService(): types.VisitService<A>;
    callMethod<M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>;
    getActor(): null | A;
    subscribeAgent(callback): (() => void);
    unsubscribeAgent(callback): void;
    updateAgent(options?): Promise<void>;
    authenticate(): Promise<types.Identity>;
    getAgent(): types.HttpAgent;
    getAuth(): null | types.AuthClient;
    getIdentity(): null | types.Identity;
    getPrincipal(): null | types.Principal;
}

Type Parameters

Hierarchy (view full)

Properties

canisterId +

Interface CreateReactorCoreReturnType<A>

interface CreateReactorCoreReturnType<A> {
    canisterId: types.CanisterId;
    actorStore: types.ActorStore<A>;
    visitFunction: types.VisitService<A>;
    agentManager: classes.AgentManager;
    getState: (() => types.ActorState<A>);
    subscribeActorState: ((listener) => (() => void));
    setState: ((partial, replace?) => void);
    agentStore: types.AgentStore;
    authStore: types.AuthStore;
    isLocalEnv: boolean;
    getAgentState: (() => types.AgentState);
    subscribeAgentState: ((listener) => (() => void));
    getAuthState: (() => types.AuthState);
    subscribeAuthState: ((listener) => (() => void));
    login: ((config?) => Promise<void>);
    logout: ((config?) => Promise<void>);
    queryCall: types.ActorQuery<A>;
    updateCall: types.ActorUpdate<A>;
    initialize(options?): Promise<void>;
    extractService(): types.VisitService<A>;
    callMethod<M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>;
    getActor(): null | A;
    subscribeAgent(callback): (() => void);
    unsubscribeAgent(callback): void;
    updateAgent(options?): Promise<void>;
    authenticate(): Promise<types.Identity>;
    getAgent(): types.HttpAgent;
    getAuth(): null | types.AuthClient;
    getIdentity(): null | types.Identity;
    getPrincipal(): null | types.Principal;
}

Type Parameters

Hierarchy (view full)

Properties

canisterId actorStore visitFunction agentManager @@ -29,10 +29,10 @@ getAuth getIdentity getPrincipal -

Properties

canisterId

canisterId: types.CanisterId

actorStore

actorStore: types.ActorStore<A>

visitFunction

visitFunction: types.VisitService<A>

agentManager

agentManager: classes.AgentManager

getState

getState: (() => types.ActorState<A>) = ...

Type declaration

subscribeActorState

subscribeActorState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

setState

setState: ((partial, replace?) => void) = ...

Type declaration

agentStore

agentStore: types.AgentStore

authStore

authStore: types.AuthStore

isLocalEnv

isLocalEnv: boolean

getAgentState

getAgentState: (() => types.AgentState) = ...

Type declaration

subscribeAgentState

subscribeAgentState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

getAuthState

getAuthState: (() => types.AuthState) = ...

Type declaration

subscribeAuthState

subscribeAuthState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

login

login: ((config?) => Promise<void>)

Type declaration

logout

logout: ((config?) => Promise<void>)

Type declaration

    • (config?): Promise<void>

    • Parameters

      • Optional config: {
            returnTo?: string;
        }
        • Optional returnTo?: string

      Returns Promise<void>

queryCall

queryCall: types.ActorQuery<A>

updateCall

updateCall: types.ActorUpdate<A>

Methods

initialize

extractService

callMethod

getActor

subscribeAgent

unsubscribeAgent

updateAgent

authenticate

getAgent

getAuth

getIdentity

getPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

canisterId

canisterId: types.CanisterId

actorStore

actorStore: types.ActorStore<A>

visitFunction

visitFunction: types.VisitService<A>

agentManager

agentManager: classes.AgentManager

getState

getState: (() => types.ActorState<A>) = ...

Type declaration

subscribeActorState

subscribeActorState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

setState

setState: ((partial, replace?) => void) = ...

Type declaration

agentStore

agentStore: types.AgentStore

authStore

authStore: types.AuthStore

isLocalEnv

isLocalEnv: boolean

getAgentState

getAgentState: (() => types.AgentState) = ...

Type declaration

subscribeAgentState

subscribeAgentState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

getAuthState

getAuthState: (() => types.AuthState) = ...

Type declaration

subscribeAuthState

subscribeAuthState: ((listener) => (() => void)) = ...

Type declaration

    • (listener): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

login

login: ((config?) => Promise<void>)

Type declaration

logout

logout: ((config?) => Promise<void>)

Type declaration

    • (config?): Promise<void>

    • Parameters

      • Optional config: {
            returnTo?: string;
        }
        • Optional returnTo?: string

      Returns Promise<void>

queryCall

queryCall: types.ActorQuery<A>

updateCall

updateCall: types.ActorUpdate<A>

Methods

initialize

extractService

callMethod

getActor

subscribeAgent

unsubscribeAgent

updateAgent

authenticate

getAgent

getAuth

getIdentity

getPrincipal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateReactorStoreParameters

interface CreateReactorStoreParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    agentManager?: classes.AgentManager;
    withProcessEnv?: boolean;
    isLocalEnv?: boolean;
    port?: number;
}

Hierarchy (view full)

Properties

source? +

Interface CreateReactorStoreParameters

interface CreateReactorStoreParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    agentManager?: classes.AgentManager;
    withProcessEnv?: boolean;
    isLocalEnv?: boolean;
    port?: number;
}

Hierarchy (view full)

Properties

source? fetch? fetchOptions? callOptions? @@ -33,10 +33,10 @@

Default

false

Default

true

Optional logToConsole

logToConsole?: boolean

Whether to log to the console. Defaults to false.

-

idlFactory

idlFactory: types.IDL.InterfaceFactory

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional agentManager

agentManager?: classes.AgentManager

Optional withProcessEnv

withProcessEnv?: boolean

Optional isLocalEnv

isLocalEnv?: boolean

Optional port

port?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

idlFactory

idlFactory: types.IDL.InterfaceFactory

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional agentManager

agentManager?: classes.AgentManager

Optional withProcessEnv

withProcessEnv?: boolean

Optional isLocalEnv

isLocalEnv?: boolean

Optional port

port?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface DefaultActorType

interface DefaultActorType {
    [key: string]: types.ActorMethod;
}

Indexable

[key: string]: types.ActorMethod

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Interface DefaultActorType

interface DefaultActorType {
    [key: string]: types.ActorMethod;
}

Indexable

[key: string]: types.ActorMethod

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Interface UpdateAgentParameters

interface UpdateAgentParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    agent?: types.HttpAgent;
}

Hierarchy (view full)

Properties

source? +

Interface UpdateAgentParameters

interface UpdateAgentParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    agent?: types.HttpAgent;
}

Hierarchy (view full)

Properties

source? fetch? fetchOptions? callOptions? @@ -25,10 +25,10 @@

Default

false

Default

true

Optional logToConsole

logToConsole?: boolean

Whether to log to the console. Defaults to false.

-

Optional agent

agent?: types.HttpAgent

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Optional agent

agent?: types.HttpAgent

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface ActorHooksReturnType<A>

interface ActorHooksReturnType<A> {
    initialize: (() => Promise<void>);
    useActorState: (() => UseActorState);
    useQueryCall: UseQueryCall<A>;
    useUpdateCall: UseUpdateCall<A>;
    useVisitMethod: UseVisitMethod<A>;
}

Type Parameters

Hierarchy (view full)

Properties

initialize +

Interface ActorHooksReturnType<A>

interface ActorHooksReturnType<A> {
    initialize: (() => Promise<void>);
    useActorState: (() => UseActorState);
    useQueryCall: UseQueryCall<A>;
    useUpdateCall: UseUpdateCall<A>;
    useVisitMethod: UseVisitMethod<A>;
}

Type Parameters

Hierarchy (view full)

Properties

initialize useActorState useQueryCall useUpdateCall useVisitMethod -

Properties

initialize

initialize: (() => Promise<void>)

Type declaration

useActorState

useActorState: (() => UseActorState)

Type declaration

useQueryCall

useQueryCall: UseQueryCall<A>

useUpdateCall

useUpdateCall: UseUpdateCall<A>

useVisitMethod

useVisitMethod: UseVisitMethod<A>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

initialize

initialize: (() => Promise<void>)

Type declaration

useActorState

useActorState: (() => UseActorState)

Type declaration

useQueryCall

useQueryCall: UseQueryCall<A>

useUpdateCall

useUpdateCall: UseUpdateCall<A>

useVisitMethod

useVisitMethod: UseVisitMethod<A>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Interface ActorMethodState<A, M>

interface ActorMethodState<A, M> {
    [key: string]: {
        data: types.ActorMethodReturnType<A[M]> | undefined;
        loading: boolean;
        error: Error | undefined;
    };
}

Type Parameters

Indexable

[key: string]: {
    data: types.ActorMethodReturnType<A[M]> | undefined;
    loading: boolean;
    error: Error | undefined;
}

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Interface ActorProviderProps

interface ActorProviderProps {
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    children?: ReactNode;
    loadingComponent?: ReactNode;
    didjsId?: string;
    canisterId?: string;
    agentContext?: Context<null | AgentContext>;
    idlFactory?: types.IDL.InterfaceFactory;
}

Hierarchy (view full)

Properties

withVisitor? +

Interface ActorProviderProps

interface ActorProviderProps {
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    children?: ReactNode;
    loadingComponent?: ReactNode;
    didjsId?: string;
    canisterId?: string;
    agentContext?: Context<null | AgentContext>;
    idlFactory?: types.IDL.InterfaceFactory;
}

Hierarchy (view full)

Properties

withVisitor? withDevtools? initializeOnCreate? children? @@ -8,10 +8,10 @@ canisterId? agentContext? idlFactory? -

Properties

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional children

children?: ReactNode

Optional loadingComponent

loadingComponent?: ReactNode

Optional didjsId

didjsId?: string

Optional canisterId

canisterId?: string

Optional agentContext

agentContext?: Context<null | AgentContext>

Optional idlFactory

idlFactory?: types.IDL.InterfaceFactory

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional children

children?: ReactNode

Optional loadingComponent

loadingComponent?: ReactNode

Optional didjsId

didjsId?: string

Optional canisterId

canisterId?: string

Optional agentContext

agentContext?: Context<null | AgentContext>

Optional idlFactory

idlFactory?: types.IDL.InterfaceFactory

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface AgentContext

interface AgentContext {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
    agentManager: types.AgentManager;
}

Hierarchy (view full)

Properties

useAgent +

Interface AgentContext

interface AgentContext {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
    agentManager: types.AgentManager;
}

Hierarchy (view full)

Properties

useAgent useAgentState useAuth useAuthState useUserPrincipal agentManager -

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

agentManager

agentManager: types.AgentManager

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

agentManager

agentManager: types.AgentManager

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface AgentHooksReturnType

interface AgentHooksReturnType {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
}

Hierarchy (view full)

Properties

useAgent +

Interface AgentHooksReturnType

interface AgentHooksReturnType {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
}

Hierarchy (view full)

Properties

useAgent useAgentState -

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface AgentProviderProps

interface AgentProviderProps {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    children?: ReactNode;
    port?: number;
    isLocalEnv?: boolean;
    withDevtools?: boolean;
    agentManager?: types.AgentManager;
}

Hierarchy (view full)

Properties

source? +

Interface AgentProviderProps

interface AgentProviderProps {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    children?: ReactNode;
    port?: number;
    isLocalEnv?: boolean;
    withDevtools?: boolean;
    agentManager?: types.AgentManager;
}

Hierarchy (view full)

Properties

source? fetch? fetchOptions? callOptions? @@ -29,10 +29,10 @@

Default

false

Default

true

Optional logToConsole

logToConsole?: boolean

Whether to log to the console. Defaults to false.

-

Optional children

children?: ReactNode

Optional port

port?: number

Optional isLocalEnv

isLocalEnv?: boolean

Optional withDevtools

withDevtools?: boolean

Optional agentManager

agentManager?: types.AgentManager

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Optional children

children?: ReactNode

Optional port

port?: number

Optional isLocalEnv

isLocalEnv?: boolean

Optional withDevtools

withDevtools?: boolean

Optional agentManager

agentManager?: types.AgentManager

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface AuthHooksReturnType

interface AuthHooksReturnType {
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
}

Hierarchy (view full)

Properties

useAuth +

Interface AuthHooksReturnType

interface AuthHooksReturnType {
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
}

Hierarchy (view full)

Properties

useAuth useAuthState useUserPrincipal -

Properties

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateActorContextParameters

interface CreateActorContextParameters {
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    didjsId?: string;
    canisterId?: string;
    agentContext?: Context<null | AgentContext>;
    idlFactory?: types.IDL.InterfaceFactory;
    loadingComponent?: ReactNode;
}

Hierarchy (view full)

Properties

withVisitor? +

Interface CreateActorContextParameters

interface CreateActorContextParameters {
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    didjsId?: string;
    canisterId?: string;
    agentContext?: Context<null | AgentContext>;
    idlFactory?: types.IDL.InterfaceFactory;
    loadingComponent?: ReactNode;
}

Hierarchy (view full)

Properties

withVisitor? withDevtools? initializeOnCreate? didjsId? @@ -7,10 +7,10 @@ agentContext? idlFactory? loadingComponent? -

Properties

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional didjsId

didjsId?: string

Optional canisterId

canisterId?: string

Optional agentContext

agentContext?: Context<null | AgentContext>

Optional idlFactory

idlFactory?: types.IDL.InterfaceFactory

Optional loadingComponent

loadingComponent?: ReactNode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional didjsId

didjsId?: string

Optional canisterId

canisterId?: string

Optional agentContext

agentContext?: Context<null | AgentContext>

Optional idlFactory

idlFactory?: types.IDL.InterfaceFactory

Optional loadingComponent

loadingComponent?: ReactNode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateActorContextReturnType<A>

interface CreateActorContextReturnType<A> {
    initialize: (() => Promise<void>);
    useActorState: (() => UseActorState);
    useQueryCall: UseQueryCall<A>;
    useUpdateCall: UseUpdateCall<A>;
    useVisitMethod: UseVisitMethod<A>;
    ActorProvider: FC<ActorProviderProps>;
}

Type Parameters

Hierarchy (view full)

Properties

initialize +

Interface CreateActorContextReturnType<A>

interface CreateActorContextReturnType<A> {
    initialize: (() => Promise<void>);
    useActorState: (() => UseActorState);
    useQueryCall: UseQueryCall<A>;
    useUpdateCall: UseUpdateCall<A>;
    useVisitMethod: UseVisitMethod<A>;
    ActorProvider: FC<ActorProviderProps>;
}

Type Parameters

Hierarchy (view full)

Properties

initialize useActorState useQueryCall useUpdateCall useVisitMethod ActorProvider -

Properties

initialize

initialize: (() => Promise<void>)

Type declaration

useActorState

useActorState: (() => UseActorState)

Type declaration

useQueryCall

useQueryCall: UseQueryCall<A>

useUpdateCall

useUpdateCall: UseUpdateCall<A>

useVisitMethod

useVisitMethod: UseVisitMethod<A>

ActorProvider

ActorProvider: FC<ActorProviderProps>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

initialize

initialize: (() => Promise<void>)

Type declaration

useActorState

useActorState: (() => UseActorState)

Type declaration

useQueryCall

useQueryCall: UseQueryCall<A>

useUpdateCall

useUpdateCall: UseUpdateCall<A>

useVisitMethod

useVisitMethod: UseVisitMethod<A>

ActorProvider

ActorProvider: FC<ActorProviderProps>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateAgentContextReturnType

interface CreateAgentContextReturnType {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
    useAgentManager: ((agentContext?) => types.AgentManager);
    AgentProvider: FC<AgentProviderProps>;
}

Hierarchy (view full)

Properties

useAgent +

Interface CreateAgentContextReturnType

interface CreateAgentContextReturnType {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
    useAgentManager: ((agentContext?) => types.AgentManager);
    AgentProvider: FC<AgentProviderProps>;
}

Hierarchy (view full)

Properties

useAgent useAgentState useAuth useAuthState useUserPrincipal useAgentManager AgentProvider -

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

useAgentManager

useAgentManager: ((agentContext?) => types.AgentManager)

Type declaration

AgentProvider

AgentProvider: FC<AgentProviderProps>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

useAgentManager

useAgentManager: ((agentContext?) => types.AgentManager)

Type declaration

AgentProvider

AgentProvider: FC<AgentProviderProps>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateReactorParameters

interface CreateReactorParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    agentManager?: types.AgentManager;
    isLocalEnv?: boolean;
    port?: number;
    withProcessEnv?: boolean;
}

Hierarchy (view full)

Properties

source? +

Interface CreateReactorParameters

interface CreateReactorParameters {
    source?: types.HttpAgent;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    fetchOptions?: Record<string, unknown>;
    callOptions?: Record<string, unknown>;
    host?: string;
    identity?: types.Identity | Promise<types.Identity>;
    credentials?: {
        name: string;
        password?: string;
    };
    useQueryNonces?: boolean;
    retryTimes?: number;
    verifyQuerySignatures?: boolean;
    logToConsole?: boolean;
    idlFactory: types.IDL.InterfaceFactory;
    canisterId: types.CanisterId;
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    agentManager?: types.AgentManager;
    isLocalEnv?: boolean;
    port?: number;
    withProcessEnv?: boolean;
}

Hierarchy (view full)

Properties

source? fetch? fetchOptions? callOptions? @@ -36,7 +36,7 @@

Default

false

idlFactory

idlFactory: types.IDL.InterfaceFactory

canisterId

canisterId: types.CanisterId

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

Optional agentManager

agentManager?: types.AgentManager

Optional isLocalEnv

isLocalEnv?: boolean

Optional port

port?: number

Optional withProcessEnv

withProcessEnv?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface CreateReactorReturnType<A>

interface CreateReactorReturnType<A> {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
    initialize: (() => Promise<void>);
    useActorState: (() => UseActorState);
    useQueryCall: UseQueryCall<A>;
    useUpdateCall: UseUpdateCall<A>;
    useVisitMethod: UseVisitMethod<A>;
    getAgent: (() => types.HttpAgent);
    getVisitFunction: (() => types.VisitService<A>);
}

Type Parameters

  • A

Hierarchy (view full)

Properties

useAgent +

Interface CreateReactorReturnType<A>

interface CreateReactorReturnType<A> {
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
    initialize: (() => Promise<void>);
    useActorState: (() => UseActorState);
    useQueryCall: UseQueryCall<A>;
    useUpdateCall: UseUpdateCall<A>;
    useVisitMethod: UseVisitMethod<A>;
    getAgent: (() => types.HttpAgent);
    getVisitFunction: (() => types.VisitService<A>);
}

Type Parameters

  • A

Hierarchy (view full)

Properties

useAgent useAgentState useAuth useAuthState @@ -11,10 +11,10 @@ useVisitMethod getAgent getVisitFunction -

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

initialize

initialize: (() => Promise<void>)

Type declaration

useActorState

useActorState: (() => UseActorState)

Type declaration

useQueryCall

useQueryCall: UseQueryCall<A>

useUpdateCall

useUpdateCall: UseUpdateCall<A>

useVisitMethod

useVisitMethod: UseVisitMethod<A>

getAgent

getAgent: (() => types.HttpAgent)

Type declaration

getVisitFunction

getVisitFunction: (() => types.VisitService<A>)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

initialize

initialize: (() => Promise<void>)

Type declaration

useActorState

useActorState: (() => UseActorState)

Type declaration

useQueryCall

useQueryCall: UseQueryCall<A>

useUpdateCall

useUpdateCall: UseUpdateCall<A>

useVisitMethod

useVisitMethod: UseVisitMethod<A>

getAgent

getAgent: (() => types.HttpAgent)

Type declaration

getVisitFunction

getVisitFunction: (() => types.VisitService<A>)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Interface DefaultActorType

interface DefaultActorType {
    [key: string]: types.ActorMethod;
}

Indexable

[key: string]: types.ActorMethod

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Interface UseActorParameters

interface UseActorParameters {
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    canisterId: string;
    idlFactory?: types.IDL.InterfaceFactory;
    agentContext?: Context<null | AgentContext>;
    didjsCanisterId?: string;
}

Hierarchy

Properties

withVisitor? +

Interface UseActorParameters

interface UseActorParameters {
    withVisitor?: boolean;
    withDevtools?: boolean;
    initializeOnCreate?: boolean;
    canisterId: string;
    idlFactory?: types.IDL.InterfaceFactory;
    agentContext?: Context<null | AgentContext>;
    didjsCanisterId?: string;
}

Hierarchy

Properties

withVisitor? withDevtools? initializeOnCreate? canisterId idlFactory? agentContext? didjsCanisterId? -

Properties

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

canisterId

canisterId: string

Optional idlFactory

idlFactory?: types.IDL.InterfaceFactory

Optional agentContext

agentContext?: Context<null | AgentContext>

Optional didjsCanisterId

didjsCanisterId?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

Optional withVisitor

withVisitor?: boolean

Optional withDevtools

withDevtools?: boolean

Optional initializeOnCreate

initializeOnCreate?: boolean

canisterId

canisterId: string

Optional idlFactory

idlFactory?: types.IDL.InterfaceFactory

Optional agentContext

agentContext?: Context<null | AgentContext>

Optional didjsCanisterId

didjsCanisterId?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface UseActorReturn<A>

interface UseActorReturn<A> {
    hooks: null | ActorHooksReturnType<A>;
    fetching: boolean;
    fetchError: null | string;
}

Type Parameters

Properties

hooks +

Interface UseActorReturn<A>

interface UseActorReturn<A> {
    hooks: null | ActorHooksReturnType<A>;
    fetching: boolean;
    fetchError: null | string;
}

Type Parameters

Properties

hooks fetching fetchError -

Properties

hooks

hooks: null | ActorHooksReturnType<A>

fetching

fetching: boolean

fetchError

fetchError: null | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

hooks

hooks: null | ActorHooksReturnType<A>

fetching

fetching: boolean

fetchError

fetchError: null | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface UseActorState

interface UseActorState {
    initialized: boolean;
    initializing: boolean;
    error: undefined | Error;
    canisterId: types.CanisterId;
}

Hierarchy

Properties

initialized +

Interface UseActorState

interface UseActorState {
    initialized: boolean;
    initializing: boolean;
    error: undefined | Error;
    canisterId: types.CanisterId;
}

Hierarchy

Properties

initialized initializing error canisterId -

Properties

initialized

initialized: boolean

initializing

initializing: boolean

error

error: undefined | Error

canisterId

canisterId: types.CanisterId

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

initialized

initialized: boolean

initializing

initializing: boolean

error

error: undefined | Error

canisterId

canisterId: types.CanisterId

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface UseAuthParameters

interface UseAuthParameters {
    onAuthentication?: ((promise) => void);
    onAuthenticationSuccess?: ((identity) => void);
    onAuthenticationFailure?: ((error) => void);
    onLoginSuccess?: ((principal) => void);
    onLoginError?: ((error) => void);
    onLogin?: ((promise) => void);
    onLoggedOut?: (() => void);
}

Properties

onAuthentication? +

Interface UseAuthParameters

interface UseAuthParameters {
    onAuthentication?: ((promise) => void);
    onAuthenticationSuccess?: ((identity) => void);
    onAuthenticationFailure?: ((error) => void);
    onLoginSuccess?: ((principal) => void);
    onLoginError?: ((error) => void);
    onLogin?: ((promise) => void);
    onLoggedOut?: (() => void);
}

Properties

onAuthentication? onAuthenticationSuccess? onAuthenticationFailure? onLoginSuccess? onLoginError? onLogin? onLoggedOut? -

Properties

Optional onAuthentication

onAuthentication?: ((promise) => void)

Type declaration

Optional onAuthenticationSuccess

onAuthenticationSuccess?: ((identity) => void)

Type declaration

Optional onAuthenticationFailure

onAuthenticationFailure?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onLoginSuccess

onLoginSuccess?: ((principal) => void)

Type declaration

Optional onLoginError

onLoginError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onLogin

onLogin?: ((promise) => void)

Type declaration

Optional onLoggedOut

onLoggedOut?: (() => void)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

Optional onAuthentication

onAuthentication?: ((promise) => void)

Type declaration

Optional onAuthenticationSuccess

onAuthenticationSuccess?: ((identity) => void)

Type declaration

Optional onAuthenticationFailure

onAuthenticationFailure?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onLoginSuccess

onLoginSuccess?: ((principal) => void)

Type declaration

Optional onLoginError

onLoginError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onLogin

onLogin?: ((promise) => void)

Type declaration

Optional onLoggedOut

onLoggedOut?: (() => void)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface UseAuthReturnType

interface UseAuthReturnType {
    error: undefined | Error;
    authenticated: boolean;
    authenticating: boolean;
    identity: null | types.Identity;
    login: ((options?) => Promise<void>);
    logout: ((options?) => Promise<void>);
    authenticate: (() => Promise<types.Identity>);
    loginLoading: boolean;
    loginError: null | Error;
}

Properties

error +

Interface UseAuthReturnType

interface UseAuthReturnType {
    error: undefined | Error;
    authenticated: boolean;
    authenticating: boolean;
    identity: null | types.Identity;
    login: ((options?) => Promise<void>);
    logout: ((options?) => Promise<void>);
    authenticate: (() => Promise<types.Identity>);
    loginLoading: boolean;
    loginError: null | Error;
}

Properties

error authenticated authenticating identity @@ -8,10 +8,10 @@ authenticate loginLoading loginError -

Properties

error

error: undefined | Error

authenticated

authenticated: boolean

authenticating

authenticating: boolean

identity

identity: null | types.Identity

login

login: ((options?) => Promise<void>)

Type declaration

logout

logout: ((options?) => Promise<void>)

Type declaration

authenticate

authenticate: (() => Promise<types.Identity>)

Type declaration

loginLoading

loginLoading: boolean

loginError

loginError: null | Error

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

error

error: undefined | Error

authenticated

authenticated: boolean

authenticating

authenticating: boolean

identity

identity: null | types.Identity

login

login: ((options?) => Promise<void>)

Type declaration

logout

logout: ((options?) => Promise<void>)

Type declaration

authenticate

authenticate: (() => Promise<types.Identity>)

Type declaration

loginLoading

loginLoading: boolean

loginError

loginError: null | Error

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface UseMethodCallReturnType<A, M>

interface UseMethodCallReturnType<A, M> {
    data: undefined | types.ActorMethodReturnType<A[M]>;
    error: undefined | Error;
    loading: boolean;
    reset: (() => void);
    call: ((eventOrReplaceArgs?) => Promise<undefined | types.ActorMethodReturnType<A[M]>>);
}

Type Parameters

Hierarchy (view full)

Properties

data +

Interface UseMethodCallReturnType<A, M>

interface UseMethodCallReturnType<A, M> {
    data: undefined | types.ActorMethodReturnType<A[M]>;
    error: undefined | Error;
    loading: boolean;
    reset: (() => void);
    call: ((eventOrReplaceArgs?) => Promise<undefined | types.ActorMethodReturnType<A[M]>>);
}

Type Parameters

Hierarchy (view full)

Properties

data error loading reset call -

Properties

data

data: undefined | types.ActorMethodReturnType<A[M]>

error

error: undefined | Error

loading

loading: boolean

reset

reset: (() => void)

Type declaration

    • (): void

    • Returns void

call

call: ((eventOrReplaceArgs?) => Promise<undefined | types.ActorMethodReturnType<A[M]>>)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

data

data: undefined | types.ActorMethodReturnType<A[M]>

error

error: undefined | Error

loading

loading: boolean

reset

reset: (() => void)

Type declaration

    • (): void

    • Returns void

call

call: ((eventOrReplaceArgs?) => Promise<undefined | types.ActorMethodReturnType<A[M]>>)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface UseQueryCallParameters<A, M>

interface UseQueryCallParameters<A, M> {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    onLoading?: ((loading) => void);
    onError?: ((error) => void);
    onSuccess?: ((data) => void);
    throwOnError?: boolean;
    refetchOnMount?: boolean;
    refetchInterval?: number | false;
}

Type Parameters

Hierarchy (view full)

Properties

functionName +

Interface UseQueryCallParameters<A, M>

interface UseQueryCallParameters<A, M> {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    onLoading?: ((loading) => void);
    onError?: ((error) => void);
    onSuccess?: ((data) => void);
    throwOnError?: boolean;
    refetchOnMount?: boolean;
    refetchInterval?: number | false;
}

Type Parameters

Hierarchy (view full)

Properties

functionName args? onLoading? onError? @@ -7,10 +7,10 @@ throwOnError? refetchOnMount? refetchInterval? -

Properties

functionName

functionName: M

Optional args

args?: types.ActorMethodParameters<A[M]>

Optional onLoading

onLoading?: ((loading) => void)

Type declaration

    • (loading): void

    • Parameters

      • loading: boolean

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onSuccess

onSuccess?: ((data) => void)

Type declaration

Optional throwOnError

throwOnError?: boolean

Optional refetchOnMount

refetchOnMount?: boolean

Optional refetchInterval

refetchInterval?: number | false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

functionName

functionName: M

Optional args

args?: types.ActorMethodParameters<A[M]>

Optional onLoading

onLoading?: ((loading) => void)

Type declaration

    • (loading): void

    • Parameters

      • loading: boolean

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onSuccess

onSuccess?: ((data) => void)

Type declaration

Optional throwOnError

throwOnError?: boolean

Optional refetchOnMount

refetchOnMount?: boolean

Optional refetchInterval

refetchInterval?: number | false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface UseUpdateCallParameters<A, M>

interface UseUpdateCallParameters<A, M> {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    onLoading?: ((loading) => void);
    onError?: ((error) => void);
    onSuccess?: ((data) => void);
    throwOnError?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

functionName +

Interface UseUpdateCallParameters<A, M>

interface UseUpdateCallParameters<A, M> {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    onLoading?: ((loading) => void);
    onError?: ((error) => void);
    onSuccess?: ((data) => void);
    throwOnError?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

functionName args? onLoading? onError? onSuccess? throwOnError? -

Properties

functionName

functionName: M

Optional args

args?: types.ActorMethodParameters<A[M]>

Optional onLoading

onLoading?: ((loading) => void)

Type declaration

    • (loading): void

    • Parameters

      • loading: boolean

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onSuccess

onSuccess?: ((data) => void)

Type declaration

Optional throwOnError

throwOnError?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

functionName

functionName: M

Optional args

args?: types.ActorMethodParameters<A[M]>

Optional onLoading

onLoading?: ((loading) => void)

Type declaration

    • (loading): void

    • Parameters

      • loading: boolean

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      Returns void

Optional onSuccess

onSuccess?: ((data) => void)

Type declaration

Optional throwOnError

throwOnError?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface DefaultField

interface DefaultField {
    maxLength?: number;
    minLength?: number;
    type: FieldType;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

maxLength? +

Interface DefaultField

interface DefaultField {
    maxLength?: number;
    minLength?: number;
    type: FieldType;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

maxLength? minLength? type label validate defaultValue? defaultValues? -

Properties

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

type

type: FieldType

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

type

type: FieldType

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface DynamicDataArgs<V>

interface DynamicDataArgs<V> {
    label: string;
    value: V;
}

Type Parameters

  • V = unknown

Properties

label +

Interface DynamicDataArgs<V>

interface DynamicDataArgs<V> {
    label: string;
    value: V;
}

Type Parameters

  • V = unknown

Properties

label value -

Properties

label

label: string

value

value: V

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

label

label: string

value

value: V

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface ExtractedServiceDetails<A>

interface ExtractedServiceDetails<A> {
    canisterId: string;
    description: string;
    methodDetails: ServiceDetails<A>;
}

Type Parameters

Properties

canisterId +

Interface ExtractedServiceDetails<A>

interface ExtractedServiceDetails<A> {
    canisterId: string;
    description: string;
    methodDetails: ServiceDetails<A>;
}

Type Parameters

Properties

canisterId description methodDetails -

Properties

canisterId

canisterId: string

description

description: string

methodDetails

methodDetails: ServiceDetails<A>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

canisterId

canisterId: string

description

description: string

methodDetails

methodDetails: ServiceDetails<A>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface ExtractedServiceFields<A>

interface ExtractedServiceFields<A> {
    canisterId: string;
    methodFields: ServiceFields<A, Extract<keyof A, string>>;
}

Type Parameters

Properties

canisterId +

Interface ExtractedServiceFields<A>

interface ExtractedServiceFields<A> {
    canisterId: string;
    methodFields: ServiceFields<A, Extract<keyof A, string>>;
}

Type Parameters

Properties

canisterId methodFields -

Properties

canisterId

canisterId: string

methodFields

methodFields: ServiceFields<A, Extract<keyof A, string>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

canisterId

canisterId: string

methodFields

methodFields: ServiceFields<A, Extract<keyof A, string>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface ExtractedServiceResults<A>

interface ExtractedServiceResults<A> {
    canisterId: string;
    methodResult: ServiceResult<A>;
}

Type Parameters

Properties

canisterId +

Interface ExtractedServiceResults<A>

interface ExtractedServiceResults<A> {
    canisterId: string;
    methodResult: ServiceResult<A>;
}

Type Parameters

Properties

canisterId methodResult -

Properties

canisterId

canisterId: string

methodResult

methodResult: ServiceResult<A>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

canisterId

canisterId: string

methodResult

methodResult: ServiceResult<A>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface FieldDetails

interface FieldDetails {
    __label: string;
    __type: FieldType;
    __description: string;
    [key: string]: string | boolean | undefined;
}

Hierarchy (view full)

Indexable

[key: string]: string | boolean | undefined

Properties

__label +

Interface FieldDetails

interface FieldDetails {
    __label: string;
    __type: FieldType;
    __description: string;
    [key: string]: string | boolean | undefined;
}

Hierarchy (view full)

Indexable

[key: string]: string | boolean | undefined

Properties

__label __type __description -

Properties

__label

__label: string

__type

__type: FieldType

__description

__description: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

__label

__label: string

__type

__type: FieldType

__description

__description: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface FieldDetailsWithChild

interface FieldDetailsWithChild {
    __hidden?: boolean;
    __checked?: boolean;
    __label: string;
    __type: FieldType;
    __description: string;
    optional?: OtherDetails;
    vector?: OtherDetails;
    [key: string]: string | boolean | undefined | OtherDetails;
}

Indexable

[key: string]: string | boolean | undefined | OtherDetails

Properties

__hidden? +

Interface FieldDetailsWithChild

interface FieldDetailsWithChild {
    __hidden?: boolean;
    __checked?: boolean;
    __label: string;
    __type: FieldType;
    __description: string;
    optional?: OtherDetails;
    vector?: OtherDetails;
    [key: string]: string | boolean | undefined | OtherDetails;
}

Indexable

[key: string]: string | boolean | undefined | OtherDetails

Properties

__hidden? __checked? __label __type __description optional? vector? -

Properties

Optional __hidden

__hidden?: boolean

Optional __checked

__checked?: boolean

__label

__label: string

__type

__type: FieldType

__description

__description: string

Optional optional

optional?: OtherDetails

Optional vector

vector?: OtherDetails

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

Optional __hidden

__hidden?: boolean

Optional __checked

__checked?: boolean

__label

__label: string

__type

__type: FieldType

__description

__description: string

Optional optional

optional?: OtherDetails

Optional vector

vector?: OtherDetails

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface InputDetails

interface InputDetails {
    __label: string;
    __type: FieldType;
    __description: string;
    __checked?: boolean;
    [key: string]: string | boolean | undefined;
}

Hierarchy (view full)

Indexable

[key: string]: string | boolean | undefined

Properties

__label +

Interface InputDetails

interface InputDetails {
    __label: string;
    __type: FieldType;
    __description: string;
    __checked?: boolean;
    [key: string]: string | boolean | undefined;
}

Hierarchy (view full)

Indexable

[key: string]: string | boolean | undefined

Properties

__label __type __description __checked? -

Properties

__label

__label: string

__type

__type: FieldType

__description

__description: string

Optional __checked

__checked?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

__label

__label: string

__type

__type: FieldType

__description

__description: string

Optional __checked

__checked?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface InputField<T>

interface InputField<T> {
    required: true;
    defaultValue: FieldTypeFromIDLType<T>;
    maxLength?: number;
    minLength?: number;
    type: FieldType;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Type Parameters

Hierarchy (view full)

Properties

required +

Interface InputField<T>

interface InputField<T> {
    required: true;
    defaultValue: FieldTypeFromIDLType<T>;
    maxLength?: number;
    minLength?: number;
    type: FieldType;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Type Parameters

Hierarchy (view full)

Properties

required defaultValue maxLength? minLength? @@ -7,10 +7,10 @@ label validate defaultValues? -

Properties

required

required: true

defaultValue

defaultValue: FieldTypeFromIDLType<T>

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

type

type: FieldType

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

required

required: true

defaultValue

defaultValue: FieldTypeFromIDLType<T>

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

type

type: FieldType

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface MethodFields<A, M>

interface MethodFields<A, M> {
    functionName: M;
    functionType: types.FunctionType;
    fields: [] | AllFieldTypes<types.IDL.Type<any>>[];
    validate: ((value) => string | boolean);
    defaultValues: ServiceDefaultValues<A, M>;
}

Type Parameters

Properties

functionName +

Interface MethodFields<A, M>

interface MethodFields<A, M> {
    functionName: M;
    functionType: types.FunctionType;
    fields: [] | AllFieldTypes<types.IDL.Type<any>>[];
    validate: ((value) => string | boolean);
    defaultValues: ServiceDefaultValues<A, M>;
}

Type Parameters

Properties

functionName functionType fields validate defaultValues -

Properties

functionName

functionName: M

functionType

functionType: types.FunctionType

fields

fields: [] | AllFieldTypes<types.IDL.Type<any>>[]

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

defaultValues

defaultValues: ServiceDefaultValues<A, M>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

functionName

functionName: M

functionType

functionType: types.FunctionType

fields

fields: [] | AllFieldTypes<types.IDL.Type<any>>[]

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

defaultValues

defaultValues: ServiceDefaultValues<A, M>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface NumberField

interface NumberField {
    type: "number";
    min?: string | number;
    max?: string | number;
    required: true;
    defaultValue: string;
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type +

Interface NumberField

interface NumberField {
    type: "number";
    min?: string | number;
    max?: string | number;
    required: true;
    defaultValue: string;
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type min? max? required @@ -9,10 +9,10 @@ label validate defaultValues? -

Properties

type

type: "number"

Optional min

min?: string | number

Optional max

max?: string | number

required

required: true

defaultValue

defaultValue: string

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "number"

Optional min

min?: string | number

Optional max

max?: string | number

required

required: true

defaultValue

defaultValue: string

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface OptionalFields

interface OptionalFields {
    type: "optional";
    field: AllFieldTypes<types.IDL.Type<any>>;
    defaultValue: [];
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type +

Interface OptionalFields

interface OptionalFields {
    type: "optional";
    field: AllFieldTypes<types.IDL.Type<any>>;
    defaultValue: [];
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type field defaultValue maxLength? @@ -7,10 +7,10 @@ label validate defaultValues? -

Properties

type

type: "optional"

field

field: AllFieldTypes<types.IDL.Type<any>>

defaultValue

defaultValue: []

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "optional"

field

field: AllFieldTypes<types.IDL.Type<any>>

defaultValue

defaultValue: []

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface PrincipalField

interface PrincipalField {
    type: "principal";
    required: true;
    maxLength: number;
    minLength: number;
    defaultValue: string;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type +

Interface PrincipalField

interface PrincipalField {
    type: "principal";
    required: true;
    maxLength: number;
    minLength: number;
    defaultValue: string;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type required maxLength minLength @@ -7,10 +7,10 @@ label validate defaultValues? -

Properties

type

type: "principal"

required

required: true

maxLength

maxLength: number

minLength

minLength: number

defaultValue

defaultValue: string

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "principal"

required

required: true

maxLength

maxLength: number

minLength

minLength: number

defaultValue

defaultValue: string

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface RecordFields<T>

interface RecordFields<T> {
    type: "record";
    fields: AllFieldTypes<T>[];
    defaultValues: Record<string, FieldTypeFromIDLType<T>>;
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
}

Type Parameters

Hierarchy (view full)

Properties

type +

Interface RecordFields<T>

interface RecordFields<T> {
    type: "record";
    fields: AllFieldTypes<T>[];
    defaultValues: Record<string, FieldTypeFromIDLType<T>>;
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
}

Type Parameters

Hierarchy (view full)

Properties

type fields defaultValues maxLength? @@ -7,10 +7,10 @@ label validate defaultValue? -

Properties

type

type: "record"

fields

fields: AllFieldTypes<T>[]

defaultValues

defaultValues: Record<string, FieldTypeFromIDLType<T>>

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "record"

fields

fields: AllFieldTypes<T>[]

defaultValues

defaultValues: Record<string, FieldTypeFromIDLType<T>>

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface RecursiveFields

interface RecursiveFields {
    type: "recursive";
    name: string;
    extract: (() => VariantFields<types.IDL.Type<any>>);
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type +

Interface RecursiveFields

interface RecursiveFields {
    type: "recursive";
    name: string;
    extract: (() => VariantFields<types.IDL.Type<any>>);
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type name extract maxLength? @@ -8,10 +8,10 @@ validate defaultValue? defaultValues? -

Properties

type

type: "recursive"

name

name: string

extract

extract: (() => VariantFields<types.IDL.Type<any>>)

Type declaration

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "recursive"

name

name: string

extract

extract: (() => VariantFields<types.IDL.Type<any>>)

Type declaration

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface ResultArrayData<A, M>

interface ResultArrayData<A, M> {
    label: string;
    value: types.ActorMethodReturnType<A[M]>[];
}

Type Parameters

Properties

label +

Interface ResultArrayData<A, M>

interface ResultArrayData<A, M> {
    label: string;
    value: types.ActorMethodReturnType<A[M]>[];
}

Type Parameters

Properties

label value -

Properties

label

label: string

value

value: types.ActorMethodReturnType<A[M]>[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

label

label: string

value

value: types.ActorMethodReturnType<A[M]>[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface ResultRecordData<A, M>

interface ResultRecordData<A, M> {
    label: string;
    value: Record<string, types.ActorMethodReturnType<A[M]>>;
}

Type Parameters

Properties

label +

Interface ResultRecordData<A, M>

interface ResultRecordData<A, M> {
    label: string;
    value: Record<string, types.ActorMethodReturnType<A[M]>>;
}

Type Parameters

Properties

label value -

Properties

label

label: string

value

value: Record<string, types.ActorMethodReturnType<A[M]>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

label

label: string

value

value: Record<string, types.ActorMethodReturnType<A[M]>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface TupleFields<T>

interface TupleFields<T> {
    type: "tuple";
    fields: AllFieldTypes<T>[];
    defaultValues: FieldTypeFromIDLType<T>[];
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
}

Type Parameters

Hierarchy (view full)

Properties

type +

Interface TupleFields<T>

interface TupleFields<T> {
    type: "tuple";
    fields: AllFieldTypes<T>[];
    defaultValues: FieldTypeFromIDLType<T>[];
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValue?: any;
}

Type Parameters

Hierarchy (view full)

Properties

type fields defaultValues maxLength? @@ -7,10 +7,10 @@ label validate defaultValue? -

Properties

type

type: "tuple"

fields

fields: AllFieldTypes<T>[]

defaultValues

defaultValues: FieldTypeFromIDLType<T>[]

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "tuple"

fields

fields: AllFieldTypes<T>[]

defaultValues

defaultValues: FieldTypeFromIDLType<T>[]

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValue

defaultValue?: any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface VariantFields<T>

interface VariantFields<T> {
    type: "variant";
    options: string[];
    defaultValue: string;
    fields: AllFieldTypes<T>[];
    defaultValues: FieldTypeFromIDLType<T>;
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
}

Type Parameters

Hierarchy (view full)

Properties

type +

Interface VariantFields<T>

interface VariantFields<T> {
    type: "variant";
    options: string[];
    defaultValue: string;
    fields: AllFieldTypes<T>[];
    defaultValues: FieldTypeFromIDLType<T>;
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
}

Type Parameters

Hierarchy (view full)

Properties

type options defaultValue fields @@ -8,10 +8,10 @@ minLength? label validate -

Properties

type

type: "variant"

options

options: string[]

defaultValue

defaultValue: string

fields

fields: AllFieldTypes<T>[]

defaultValues

defaultValues: FieldTypeFromIDLType<T>

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "variant"

options

options: string[]

defaultValue

defaultValue: string

fields

fields: AllFieldTypes<T>[]

defaultValues

defaultValues: FieldTypeFromIDLType<T>

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Interface VectorFields

interface VectorFields {
    type: "vector";
    field: AllFieldTypes<types.IDL.Type<any>>;
    defaultValue: [];
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type +

Interface VectorFields

interface VectorFields {
    type: "vector";
    field: AllFieldTypes<types.IDL.Type<any>>;
    defaultValue: [];
    maxLength?: number;
    minLength?: number;
    label: string;
    validate: ((value) => string | boolean);
    defaultValues?: any[] | Record<string, any>;
}

Hierarchy (view full)

Properties

type field defaultValue maxLength? @@ -7,10 +7,10 @@ label validate defaultValues? -

Properties

type

type: "vector"

field

field: AllFieldTypes<types.IDL.Type<any>>

defaultValue

defaultValue: []

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+

Properties

type

type: "vector"

field

field: AllFieldTypes<types.IDL.Type<any>>

defaultValue

defaultValue: []

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

label

label: string

validate

validate: ((value) => string | boolean)

Type declaration

    • (value): string | boolean

    • Parameters

      • value: any

      Returns string | boolean

Optional defaultValues

defaultValues?: any[] | Record<string, any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Namespace classes

Index

Classes

ActorManager +

Namespace classes

Index

Classes

ActorManager AgentManager CandidAdapter

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace tools

Index

Variables

IC_HOST_NETWORK_URI +

Namespace tools

Index

Variables

IC_HOST_NETWORK_URI LOCAL_HOST_NETWORK_URI DEFAULT_LOCAL_DIDJS_ID DEFAULT_IC_DIDJS_ID @@ -15,7 +15,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace types

References

ActorManager +

Namespace types

References

ActorManager AgentManager

Namespaces

IDL

Classes

HttpAgent @@ -49,7 +49,7 @@

References

ActorManager

Re-exports ActorManager

AgentManager

Re-exports AgentManager

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
-

Namespace core

Index

Main

createCandidAdapter +

Namespace core

Index

Main

createCandidAdapter createAgentManager createActorManager createReactorStore

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace helpers

Index

Functions

actorHooks +

Namespace helpers

Index

Functions

actorHooks agentHooks authHooks extractActorContext @@ -7,7 +7,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace types

Index

Namespaces

IDL +

Namespace types

Index

Namespaces

IDL

Classes

HttpAgent AuthClient Principal @@ -77,7 +77,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace helper

Index

Functions

extractAndSortArgs +

Namespace helper

Index

Functions

extractAndSortArgs convertStringToNumber validateNumberError validateError @@ -9,7 +9,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace types

Index

Interfaces

ExtractedServiceDetails +

Namespace types

Index

Interfaces

ExtractedServiceDetails FieldDetails InputDetails FieldDetailsWithChild @@ -40,7 +40,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorCallFunction<A, M>

ActorCallFunction<A, M>: ((replaceArgs?) => Promise<types.ActorMethodReturnType<A[M]>>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorCallFunction<A, M>

ActorCallFunction<A, M>: ((replaceArgs?) => Promise<types.ActorMethodReturnType<A[M]>>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorGetStateFunction<A, M>

ActorGetStateFunction<A, M>: {
    (key): types.ActorMethodReturnType<A[M]>;
    (key): boolean;
    (key): undefined | Error;
    (): {
        data: types.ActorMethodReturnType<A[M]> | undefined;
        loading: boolean;
        error: Error | undefined;
    };
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorGetStateFunction<A, M>

ActorGetStateFunction<A, M>: {
    (key): types.ActorMethodReturnType<A[M]>;
    (key): boolean;
    (key): undefined | Error;
    (): {
        data: types.ActorMethodReturnType<A[M]> | undefined;
        loading: boolean;
        error: Error | undefined;
    };
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorMethodCall<A>

ActorMethodCall<A>: (<M>(functionName, ...args) => types.ActorUpdateReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorMethodCall<A>

ActorMethodCall<A>: (<M>(functionName, ...args) => types.ActorUpdateReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorMethodParameters<T>

ActorMethodParameters<T>: T extends types.ActorMethod<infer Args, any>
    ? Args
    : never

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorMethodParameters<T>

ActorMethodParameters<T>: T extends types.ActorMethod<infer Args, any>
    ? Args
    : never

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorMethodReturnType<T>

ActorMethodReturnType<T>: T extends types.ActorMethod<any, infer Ret>
    ? Ret
    : never

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorMethodReturnType<T>

ActorMethodReturnType<T>: T extends types.ActorMethod<any, infer Ret>
    ? Ret
    : never

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorMethodStates<A>

ActorMethodStates<A>: {
    [M in types.FunctionName<A>]: types.ActorMethodState<A, M>
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorMethodStates<A>

ActorMethodStates<A>: {
    [M in types.FunctionName<A>]: types.ActorMethodState<A, M>
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorQuery<A>

ActorQuery<A>: (<M>(config) => types.ActorQueryReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorQuery<A>

ActorQuery<A>: (<M>(config) => types.ActorQueryReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorQueryParameters<A, M>

ActorQueryParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    refetchOnMount?: boolean;
    refetchInterval?: number | false;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorQueryParameters<A, M>

ActorQueryParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    refetchOnMount?: boolean;
    refetchInterval?: number | false;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorQueryReturnType<A, M>

ActorQueryReturnType<A, M>: {
    intervalId: NodeJS.Timeout | null;
    requestHash: string;
    getState: types.ActorGetStateFunction<A, M>;
    subscribe: types.ActorSubscribeFunction<A, M>;
    call: types.ActorCallFunction<A, M>;
    dataPromise: Promise<types.ActorMethodReturnType<A[M]>>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorQueryReturnType<A, M>

ActorQueryReturnType<A, M>: {
    intervalId: NodeJS.Timeout | null;
    requestHash: string;
    getState: types.ActorGetStateFunction<A, M>;
    subscribe: types.ActorSubscribeFunction<A, M>;
    call: types.ActorCallFunction<A, M>;
    dataPromise: Promise<types.ActorMethodReturnType<A[M]>>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorState<A>

ActorState<A>: {
    initialized: boolean;
    initializing: boolean;
    error: Error | undefined;
    methodState: types.ActorMethodStates<A>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorState<A>

ActorState<A>: {
    initialized: boolean;
    initializing: boolean;
    error: Error | undefined;
    methodState: types.ActorMethodStates<A>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorStore<A>

ActorStore<A>: StoreApi<types.ActorState<A>>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorStore<A>

ActorStore<A>: StoreApi<types.ActorState<A>>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorSubscribeFunction<A, M>

ActorSubscribeFunction<A, M>: ((callback) => (() => void))

Type Parameters

Type declaration

    • (callback): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorSubscribeFunction<A, M>

ActorSubscribeFunction<A, M>: ((callback) => (() => void))

Type Parameters

Type declaration

    • (callback): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorUpdate<A>

ActorUpdate<A>: (<M>(config) => types.ActorUpdateReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorUpdate<A>

ActorUpdate<A>: (<M>(config) => types.ActorUpdateReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorUpdateParameters<A, M>

ActorUpdateParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorUpdateParameters<A, M>

ActorUpdateParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorUpdateReturnType<A, M>

ActorUpdateReturnType<A, M>: {
    requestHash: string;
    getState: types.ActorGetStateFunction<A, M>;
    subscribe: types.ActorSubscribeFunction<A, M>;
    call: types.ActorCallFunction<A, M>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorUpdateReturnType<A, M>

ActorUpdateReturnType<A, M>: {
    requestHash: string;
    getState: types.ActorGetStateFunction<A, M>;
    subscribe: types.ActorSubscribeFunction<A, M>;
    call: types.ActorCallFunction<A, M>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AgentStore

AgentStore: StoreApi<types.AgentState>

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AgentStore

AgentStore: StoreApi<types.AgentState>

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthStore

AuthStore: StoreApi<types.AuthState>

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthStore

AuthStore: StoreApi<types.AuthState>

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias BaseActor<T>

BaseActor<T>: types.ActorSubclass<T>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias BaseActor<T>

BaseActor<T>: types.ActorSubclass<T>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias CallActorMethod<A>

CallActorMethod<A>: (<M>(functionName, ...args) => Promise<types.ActorMethodReturnType<A[M]>>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias CallActorMethod<A>

CallActorMethod<A>: (<M>(functionName, ...args) => Promise<types.ActorMethodReturnType<A[M]>>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias CanisterId

CanisterId: string | types.Principal

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias CanisterId

CanisterId: string | types.Principal

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias FunctionName<A>

FunctionName<A>: Extract<keyof A, string>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias FunctionName<A>

FunctionName<A>: Extract<keyof A, string>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias FunctionType

FunctionType: "query" | "update"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias FunctionType

FunctionType: "query" | "update"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias VisitService<A, M>

VisitService<A, M>: {
    [K in M]: (<V>(extractorClass, data?) => ReturnType<V["visitFunc"]>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias VisitService<A, M>

VisitService<A, M>: {
    [K in M]: (<V>(extractorClass, data?) => ReturnType<V["visitFunc"]>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias VisitorType<V>

VisitorType<V>: V extends types.IDL.Visitor<infer D, infer R>
    ? {
        data: D;
        returnType: R;
    }
    : never

Type Parameters

  • V

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias VisitorType<V>

VisitorType<V>: V extends types.IDL.Visitor<infer D, infer R>
    ? {
        data: D;
        returnType: R;
    }
    : never

Type Parameters

  • V

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorCallFunction<A, M>

ActorCallFunction<A, M>: ((replaceArgs?) => Promise<types.ActorMethodReturnType<A[M]>>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ActorCallState<A, M>

ActorCallState<A, M>: {
    data: types.ActorMethodReturnType<A[M]> | undefined;
    error: Error | undefined;
    loading: boolean;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ActorCallState<A, M>

ActorCallState<A, M>: {
    data: types.ActorMethodReturnType<A[M]> | undefined;
    error: Error | undefined;
    loading: boolean;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorGetStateFunction<A, M>

ActorGetStateFunction<A, M>: {
    (key): types.ActorMethodReturnType<A[M]>;
    (key): boolean;
    (key): undefined | Error;
    (): {
        data: types.ActorMethodReturnType<A[M]> | undefined;
        loading: boolean;
        error: Error | undefined;
    };
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorMethodCall<A>

ActorMethodCall<A>: (<M>(functionName, ...args) => types.ActorUpdateReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorMethodParameters<T>

ActorMethodParameters<T>: T extends types.ActorMethod<infer Args, any>
    ? Args
    : never

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorMethodReturnType<T>

ActorMethodReturnType<T>: T extends types.ActorMethod<any, infer Ret>
    ? Ret
    : never

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorMethodStates<A>

ActorMethodStates<A>: {
    [M in types.FunctionName<A>]: types.ActorMethodState<A, M>
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorQuery<A>

ActorQuery<A>: (<M>(config) => types.ActorQueryReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorQueryParameters<A, M>

ActorQueryParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    refetchOnMount?: boolean;
    refetchInterval?: number | false;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorQueryReturnType<A, M>

ActorQueryReturnType<A, M>: {
    intervalId: NodeJS.Timeout | null;
    requestHash: string;
    getState: types.ActorGetStateFunction<A, M>;
    subscribe: types.ActorSubscribeFunction<A, M>;
    call: types.ActorCallFunction<A, M>;
    dataPromise: Promise<types.ActorMethodReturnType<A[M]>>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorState<A>

ActorState<A>: {
    initialized: boolean;
    initializing: boolean;
    error: Error | undefined;
    methodState: types.ActorMethodStates<A>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorStore<A>

ActorStore<A>: StoreApi<types.ActorState<A>>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorSubscribeFunction<A, M>

ActorSubscribeFunction<A, M>: ((callback) => (() => void))

Type Parameters

Type declaration

    • (callback): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorUpdate<A>

ActorUpdate<A>: (<M>(config) => types.ActorUpdateReturnType<A, M>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorUpdateParameters<A, M>

ActorUpdateParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ActorUpdateReturnType<A, M>

ActorUpdateReturnType<A, M>: {
    requestHash: string;
    getState: types.ActorGetStateFunction<A, M>;
    subscribe: types.ActorSubscribeFunction<A, M>;
    call: types.ActorCallFunction<A, M>;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias AgentStore

AgentStore: StoreApi<types.AgentState>

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias AuthStore

AuthStore: StoreApi<types.AuthState>

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias BaseActor<T>

BaseActor<T>: types.ActorSubclass<T>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias CallActorMethod<A>

CallActorMethod<A>: (<M>(functionName, ...args) => Promise<types.ActorMethodReturnType<A[M]>>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias CanisterId

CanisterId: string | types.Principal

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias FunctionName<A>

FunctionName<A>: Extract<keyof A, string>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias FunctionType

FunctionType: "query" | "update"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias LoginParameters

LoginParameters: types.AuthClientLoginOptions

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias LoginParameters

LoginParameters: types.AuthClientLoginOptions

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias LoginState

LoginState: {
    loading: boolean;
    error: Error | null;
}

Type declaration

  • loading: boolean
  • error: Error | null

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias LoginState

LoginState: {
    loading: boolean;
    error: Error | null;
}

Type declaration

  • loading: boolean
  • error: Error | null

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias LogoutParameters

LogoutParameters: {
    returnTo?: string;
}

Type declaration

  • Optional returnTo?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias LogoutParameters

LogoutParameters: {
    returnTo?: string;
}

Type declaration

  • Optional returnTo?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias UseMethodCall<A>

UseMethodCall<A>: (<M>(args) => UseMethodCallReturnType<A, M>)

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias UseMethodCall<A>

UseMethodCall<A>: (<M>(args) => UseMethodCallReturnType<A, M>)

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias UseMethodCallParameters<A, M>

UseMethodCallParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    onLoading?: ((loading) => void);
    onError?: ((error) => void);
    onSuccess?: ((data) => void);
    throwOnError?: boolean;
}

Type Parameters

Type declaration

  • functionName: M
  • Optional args?: types.ActorMethodParameters<A[M]>
  • Optional onLoading?: ((loading) => void)
      • (loading): void

      • Parameters

        • loading: boolean

        Returns void

  • Optional onError?: ((error) => void)
      • (error): void

      • Parameters

        Returns void

  • Optional onSuccess?: ((data) => void)
  • Optional throwOnError?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias UseMethodCallParameters<A, M>

UseMethodCallParameters<A, M>: {
    functionName: M;
    args?: types.ActorMethodParameters<A[M]>;
    onLoading?: ((loading) => void);
    onError?: ((error) => void);
    onSuccess?: ((data) => void);
    throwOnError?: boolean;
}

Type Parameters

Type declaration

  • functionName: M
  • Optional args?: types.ActorMethodParameters<A[M]>
  • Optional onLoading?: ((loading) => void)
      • (loading): void

      • Parameters

        • loading: boolean

        Returns void

  • Optional onError?: ((error) => void)
      • (error): void

      • Parameters

        Returns void

  • Optional onSuccess?: ((data) => void)
  • Optional throwOnError?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias UseQueryCall<A>

UseQueryCall<A>: (<M>(args) => UseMethodCallReturnType<A, M>)

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias UseQueryCall<A>

UseQueryCall<A>: (<M>(args) => UseMethodCallReturnType<A, M>)

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias UseUpdateCall<A>

UseUpdateCall<A>: (<M>(args) => UseMethodCallReturnType<A, M>)

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias UseUpdateCall<A>

UseUpdateCall<A>: (<M>(args) => UseMethodCallReturnType<A, M>)

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias UseVisitMethod<A>

UseVisitMethod<A>: (<M>(functionName) => types.VisitService<A>[M])

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias UseVisitMethod<A>

UseVisitMethod<A>: (<M>(functionName) => types.VisitService<A>[M])

Type Parameters

  • A

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias VisitService<A, M>

VisitService<A, M>: {
    [K in M]: (<V>(extractorClass, data?) => ReturnType<V["visitFunc"]>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias VisitorType<V>

VisitorType<V>: V extends types.IDL.Visitor<infer D, infer R>
    ? {
        data: D;
        returnType: R;
    }
    : never

Type Parameters

  • V

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AllFieldTypes<T>

AllFieldTypes<T>: RecordFields<T> | TupleFields<T> | VariantFields<T> | VectorFields | OptionalFields | RecursiveFields | PrincipalField | NumberField | InputField<T>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AllFieldTypes<T>

AllFieldTypes<T>: RecordFields<T> | TupleFields<T> | VariantFields<T> | VectorFields | OptionalFields | RecursiveFields | PrincipalField | NumberField | InputField<T>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AllNumberTypes

AllNumberTypes: types.IDL.NatClass | types.IDL.IntClass | types.IDL.NatClass | types.IDL.FixedNatClass | types.IDL.FixedIntClass | types.IDL.FloatClass

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AllNumberTypes

AllNumberTypes: types.IDL.NatClass | types.IDL.IntClass | types.IDL.NatClass | types.IDL.FixedNatClass | types.IDL.FixedIntClass | types.IDL.FloatClass

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias DynamicFieldType<T>

DynamicFieldType<T>: T extends "record"
    ? RecordFields<types.IDL.Type>
    : T extends "variant"
        ? VariantFields<types.IDL.Type>
        : T extends "tuple"
            ? TupleFields<types.IDL.Type>
            : T extends "optional"
                ? OptionalFields
                : T extends "vector"
                    ? VectorFields
                    : T extends "recursive"
                        ? RecursiveFields
                        : T extends "unknown"
                            ? InputField<types.IDL.Type>
                            : T extends "text"
                                ? InputField<types.IDL.TextClass>
                                : T extends "number"
                                    ? NumberField
                                    : T extends "principal"
                                        ? PrincipalField
                                        : T extends "boolean"
                                            ? InputField<types.IDL.BoolClass>
                                            : T extends "null"
                                                ? InputField<types.IDL.NullClass>
                                                : never

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias DynamicFieldType<T>

DynamicFieldType<T>: T extends "record"
    ? RecordFields<types.IDL.Type>
    : T extends "variant"
        ? VariantFields<types.IDL.Type>
        : T extends "tuple"
            ? TupleFields<types.IDL.Type>
            : T extends "optional"
                ? OptionalFields
                : T extends "vector"
                    ? VectorFields
                    : T extends "recursive"
                        ? RecursiveFields
                        : T extends "unknown"
                            ? InputField<types.IDL.Type>
                            : T extends "text"
                                ? InputField<types.IDL.TextClass>
                                : T extends "number"
                                    ? NumberField
                                    : T extends "principal"
                                        ? PrincipalField
                                        : T extends "boolean"
                                            ? InputField<types.IDL.BoolClass>
                                            : T extends "null"
                                                ? InputField<types.IDL.NullClass>
                                                : never

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias DynamicFieldTypeByClass<T>

DynamicFieldTypeByClass<T>: T extends types.IDL.RecordClass
    ? RecordFields<T>
    : T extends types.IDL.TupleClass<types.IDL.Type[]>
        ? TupleFields<T>
        : T extends types.IDL.VariantClass
            ? VariantFields<T>
            : T extends types.IDL.VecClass<types.IDL.Type>
                ? VectorFields
                : T extends types.IDL.OptClass<types.IDL.Type>
                    ? OptionalFields
                    : T extends types.IDL.RecClass<types.IDL.Type>
                        ? RecursiveFields
                        : T extends types.IDL.PrincipalClass
                            ? PrincipalField
                            : T extends AllNumberTypes
                                ? NumberField
                                : InputField<T>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias DynamicFieldTypeByClass<T>

DynamicFieldTypeByClass<T>: T extends types.IDL.RecordClass
    ? RecordFields<T>
    : T extends types.IDL.TupleClass<types.IDL.Type[]>
        ? TupleFields<T>
        : T extends types.IDL.VariantClass
            ? VariantFields<T>
            : T extends types.IDL.VecClass<types.IDL.Type>
                ? VectorFields
                : T extends types.IDL.OptClass<types.IDL.Type>
                    ? OptionalFields
                    : T extends types.IDL.RecClass<types.IDL.Type>
                        ? RecursiveFields
                        : T extends types.IDL.PrincipalClass
                            ? PrincipalField
                            : T extends AllNumberTypes
                                ? NumberField
                                : InputField<T>

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ExtraInputFormFields

ExtraInputFormFields: Partial<{
    maxLength: number;
    minLength: number;
}>

Type declaration

  • maxLength: number
  • minLength: number

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ExtraInputFormFields

ExtraInputFormFields: Partial<{
    maxLength: number;
    minLength: number;
}>

Type declaration

  • maxLength: number
  • minLength: number

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias FieldType

FieldType: "record" | "variant" | "tuple" | "optional" | "vector" | "recursive" | "unknown" | "text" | "number" | "principal" | "boolean" | "null"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias FieldType

FieldType: "record" | "variant" | "tuple" | "optional" | "vector" | "recursive" | "unknown" | "text" | "number" | "principal" | "boolean" | "null"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias FieldTypeFromIDLType<T>

FieldTypeFromIDLType<T>: T extends types.IDL.Type
    ? ReturnType<T["decodeValue"]>
    : types.IDL.Type

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias FieldTypeFromIDLType<T>

FieldTypeFromIDLType<T>: T extends types.IDL.Type
    ? ReturnType<T["decodeValue"]>
    : types.IDL.Type

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias FunctionCategory

FunctionCategory: "home" | "wallet" | "governance" | "setting"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias FunctionCategory

FunctionCategory: "home" | "wallet" | "governance" | "setting"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias MethodDefaultValues<T>

MethodDefaultValues<T>: {
    [key: `arg${number}`]: FieldTypeFromIDLType<T>;
}

Type Parameters

  • T = string

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias MethodDefaultValues<T>

MethodDefaultValues<T>: {
    [key: `arg${number}`]: FieldTypeFromIDLType<T>;
}

Type Parameters

  • T = string

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias MethodDetails<A>

MethodDetails<A>: {
    functionType: types.FunctionType;
    functionName: types.FunctionName<A>;
    category: FunctionCategory;
    order: number;
    __label: string;
    __description: string;
    [key: `arg${number}`]: FieldDetailsWithChild;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias MethodDetails<A>

MethodDetails<A>: {
    functionType: types.FunctionType;
    functionName: types.FunctionName<A>;
    category: FunctionCategory;
    order: number;
    __label: string;
    __description: string;
    [key: `arg${number}`]: FieldDetailsWithChild;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias MethodResult<A, M>

MethodResult<A, M>: {
    type: ReturnDataType;
    label: string;
    value?: MethodResultValue<A, M>;
    values?: MethodResult<A, M>[];
    description: string[] | string;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias MethodResult<A, M>

MethodResult<A, M>: {
    type: ReturnDataType;
    label: string;
    value?: MethodResultValue<A, M>;
    values?: MethodResult<A, M>[];
    description: string[] | string;
}

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias MethodResultValue<A, M>

MethodResultValue<A, M>: types.ActorMethodReturnType<A[M]> | MethodResult<A, M> | number | string | boolean | types.Principal | Uint8Array | null

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias MethodResultValue<A, M>

MethodResultValue<A, M>: types.ActorMethodReturnType<A[M]> | MethodResult<A, M> | number | string | boolean | types.Principal | Uint8Array | null

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias OtherDetails

OtherDetails: FieldDetails | FieldDetailsWithChild | FieldDetailsWithChild[] | FieldDetails[]

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias OtherDetails

OtherDetails: FieldDetails | FieldDetailsWithChild | FieldDetailsWithChild[] | FieldDetails[]

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ReturnDataType

ReturnDataType: "record" | "variant" | "tuple" | "optional" | "vector" | "recursive" | "unknown" | "text" | "number" | "principal" | "boolean" | "null" | "blob" | "url" | "image" | "normal" | "table"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ReturnDataType

ReturnDataType: "record" | "variant" | "tuple" | "optional" | "vector" | "recursive" | "unknown" | "text" | "number" | "principal" | "boolean" | "null" | "blob" | "url" | "image" | "normal" | "table"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ServiceDefaultValues<A, M>

ServiceDefaultValues<A, M>: {
    [key in M]: MethodDefaultValues<M>
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ServiceDefaultValues<A, M>

ServiceDefaultValues<A, M>: {
    [key in M]: MethodDefaultValues<M>
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ServiceDetails<A>

ServiceDetails<A>: {
    [K in types.FunctionName<A>]: (<ExtractorClass>(extractorClass?) => MethodDetails<A>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ServiceDetails<A>

ServiceDetails<A>: {
    [K in types.FunctionName<A>]: (<ExtractorClass>(extractorClass?) => MethodDetails<A>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ServiceFields<A, M>

ServiceFields<A, M>: {
    [key in M]: (<ExtractorClass>(extractorClass?) => MethodFields<A, M>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ServiceFields<A, M>

ServiceFields<A, M>: {
    [key in M]: (<ExtractorClass>(extractorClass?) => MethodFields<A, M>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias ServiceResult<A>

ServiceResult<A>: {
    [K in types.FunctionName<A>]: (<ExtractorClass>(data, extractorClass?) => MethodResult<A>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias ServiceResult<A>

ServiceResult<A>: {
    [K in types.FunctionName<A>]: (<ExtractorClass>(data, extractorClass?) => MethodResult<A>)
}

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Variable DEFAULT_IC_DIDJS_IDConst

DEFAULT_IC_DIDJS_ID: "a4gq6-oaaaa-aaaab-qaa4q-cai" = "a4gq6-oaaaa-aaaab-qaa4q-cai"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Variable DEFAULT_IC_DIDJS_IDConst

DEFAULT_IC_DIDJS_ID: "a4gq6-oaaaa-aaaab-qaa4q-cai" = "a4gq6-oaaaa-aaaab-qaa4q-cai"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Variable DEFAULT_LOCAL_DIDJS_IDConst

DEFAULT_LOCAL_DIDJS_ID: "bd3sg-teaaa-aaaaa-qaaba-cai" = "bd3sg-teaaa-aaaaa-qaaba-cai"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Variable DEFAULT_LOCAL_DIDJS_IDConst

DEFAULT_LOCAL_DIDJS_ID: "bd3sg-teaaa-aaaaa-qaaba-cai" = "bd3sg-teaaa-aaaaa-qaaba-cai"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Variable IC_HOST_NETWORK_URIConst

IC_HOST_NETWORK_URI: "https://ic0.app" = "https://ic0.app"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Variable IC_HOST_NETWORK_URIConst

IC_HOST_NETWORK_URI: "https://ic0.app" = "https://ic0.app"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Variable IC_INTERNET_IDENTITY_PROVIDERConst

IC_INTERNET_IDENTITY_PROVIDER: "https://identity.ic0.app/#authorize" = "https://identity.ic0.app/#authorize"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Variable IC_INTERNET_IDENTITY_PROVIDERConst

IC_INTERNET_IDENTITY_PROVIDER: "https://identity.ic0.app/#authorize" = "https://identity.ic0.app/#authorize"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Variable LOCAL_HOST_NETWORK_URIConst

LOCAL_HOST_NETWORK_URI: "http://127.0.0.1:4943" = "http://127.0.0.1:4943"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Variable LOCAL_HOST_NETWORK_URIConst

LOCAL_HOST_NETWORK_URI: "http://127.0.0.1:4943" = "http://127.0.0.1:4943"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Variable LOCAL_INTERNET_IDENTITY_PROVIDERConst

LOCAL_INTERNET_IDENTITY_PROVIDER: "http://rdmx6-jaaaa-aaaaa-aaadq-cai.localhost:4943/#authorize" = "http://rdmx6-jaaaa-aaaaa-aaadq-cai.localhost:4943/#authorize"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Variable LOCAL_INTERNET_IDENTITY_PROVIDERConst

LOCAL_INTERNET_IDENTITY_PROVIDER: "http://rdmx6-jaaaa-aaaaa-aaadq-cai.localhost:4943/#authorize" = "http://rdmx6-jaaaa-aaaaa-aaadq-cai.localhost:4943/#authorize"

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable BoolConst

Bool: types.IDL.BoolClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EmptyConst

Empty: types.IDL.EmptyClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Float32Const

Float32: types.IDL.FloatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Float64Const

Float64: types.IDL.FloatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable IntConst

Int: types.IDL.IntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int16Const

Int16: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int32Const

Int32: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int64Const

Int64: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int8Const

Int8: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NatConst

Nat: types.IDL.NatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat16Const

Nat16: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat32Const

Nat32: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat64Const

Nat64: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat8Const

Nat8: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NullConst

Null: types.IDL.NullClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable PrincipalConst

Principal: types.IDL.PrincipalClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable ReservedConst

Reserved: types.IDL.ReservedClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable TextConst

Text: types.IDL.TextClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable BoolConst

Bool: types.IDL.BoolClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable EmptyConst

Empty: types.IDL.EmptyClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Float32Const

Float32: types.IDL.FloatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Float64Const

Float64: types.IDL.FloatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable IntConst

Int: types.IDL.IntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int16Const

Int16: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int32Const

Int32: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int64Const

Int64: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Int8Const

Int8: types.IDL.FixedIntClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NatConst

Nat: types.IDL.NatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat16Const

Nat16: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat32Const

Nat32: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat64Const

Nat64: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable Nat8Const

Nat8: types.IDL.FixedNatClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable NullConst

Null: types.IDL.NullClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable PrincipalConst

Principal: types.IDL.PrincipalClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable ReservedConst

Reserved: types.IDL.ReservedClass

Settings

Member Visibility

Theme

Generated using TypeDoc

Variable TextConst

Text: types.IDL.TextClass

Settings

Member Visibility

Theme

Generated using TypeDoc