Class ActorManager<A>

Type Parameters

A = types.BaseActor

Constructors

constructor

new ActorManager<A>(actorConfig): classes.ActorManager<A>
Type Parameters
- A = types.BaseActor
Parameters
- actorConfig: types.ActorManagerParameters
Returns classes.ActorManager<A>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:90

Properties

`Private` _actor

_actor: null | A = null

`Private` _idlFactory

_idlFactory: types.IDL.InterfaceFactory

`Private` _agentManager

_agentManager: classes.AgentManager

`Private` _unsubscribeAgent

_unsubscribeAgent: (() => void)

Type declaration

- (): void
- Returns void

`Private` _subscribers

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

Type declaration

- (): void
- Returns void

canisterId

canisterId: string

getState

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

Type declaration

- (): types.ActorState<A>
- Returns types.ActorState<A>

subscribeActorState

subscribeActorState: {
(listener): (() => void);
<U>(selector, listener, options?): (() => void);
} = ...

Type declaration

- (listener): (() => void)
- Parameters
  - listener: ((selectedState, previousSelectedState) => void)
    - (selectedState, previousSelectedState): void
      Parameters
      selectedState: types.ActorState<A>
      previousSelectedState: types.ActorState<A>
      Returns void
  Returns (() => void)
  - - (): void
    - Returns void
- <U>(selector, listener, options?): (() => void)
- Type Parameters
  - U
  Parameters
  - selector: ((state) => U)
    - (state): U
      Parameters
      state: types.ActorState<A>
      Returns U
  - listener: ((selectedState, previousSelectedState) => void)
    - (selectedState, previousSelectedState): void
      Parameters
      selectedState: U
      previousSelectedState: U
      Returns void
  - Optional options: {
    equalityFn?: ((a, b) => boolean);
    fireImmediately?: boolean;
    }
    - Optional equalityFn?: ((a, b) => boolean)
      (a, b): boolean
      Parameters
      a: U
      b: U
      Returns boolean
    - Optional fireImmediately?: boolean
  Returns (() => void)
  - - (): void
    - Returns void

setState

setState: {
(...a): void;
(...a): void;
} = ...

Type declaration

- (...a): void
- Parameters
  - Rest ...a: [partial: types.ActorState<A> | Partial<types.ActorState<A>> | ((state) => types.ActorState<A> | Partial<types.ActorState<A>>), replace?: false, action?: Action]
  Returns void
- (...a): void
- Parameters
  - Rest ...a: [state: types.ActorState<A> | ((state) => types.ActorState<A>), replace: true, action?: Action]
  Returns void

Accessors

agentManager

get agentManager(): classes.AgentManager
Returns classes.AgentManager
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:303

Methods

`Private` updateState

updateState(newState, action?): void
Parameters
- newState: Partial<types.ActorState<A>>
- Optional action: string
Returns void
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:50

updateMethodState

updateMethodState(method, hash, newState): void
Parameters
- method: Extract<keyof A, string>
- hash: string
- newState: Partial<{
      data: undefined | types.ActorMethodReturnType<A[Extract<keyof A, string>]>;
      loading: boolean;
      error: undefined | Error;
  }>
Returns void
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:58

initialize

initialize(options?): Promise<void>
Parameters
- Optional options: types.UpdateAgentParameters
Returns Promise<void>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:140

extractInterface

extractInterface(): types.IDL.ServiceClass
Returns types.IDL.ServiceClass
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:144

extractMethodAttributes

extractMethodAttributes(): types.MethodAttributes<A>
Returns types.MethodAttributes<A>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:148

extractVisitor

extractVisitor(): types.VisitService<A>
Returns types.VisitService<A>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:174

`Private` initializeActor

initializeActor(agent): void
Parameters
- agent: types.HttpAgent
Returns void
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:191

`Private` _getActorMethod

_getActorMethod<M>(functionName): types.ActorMethodType<A, M>
Type Parameters
- M extends string
Parameters
- functionName: M
Returns types.ActorMethodType<A, M>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:233

callMethod

callMethod<M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>
Type Parameters
- M extends string
Parameters
- functionName: M
- Rest ...args: types.ActorMethodParameters<A[M]>
Returns Promise<types.ActorMethodReturnType<A[M]>>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:248

callMethodWithOptions

callMethodWithOptions(options): (<M>(functionName, ...args) => Promise<types.ActorMethodReturnType<A[M]>>)
Parameters
- options: utils.agent.CallConfig
Returns (<M>(functionName, ...args) => Promise<types.ActorMethodReturnType<A[M]>>)
- - <M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>
  - Type Parameters
    - M extends string
    Parameters
    - functionName: M
    - Rest ...args: types.ActorMethodParameters<A[M]>
    Returns Promise<types.ActorMethodReturnType<A[M]>>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:259

call

call<M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>
Type Parameters
- M extends string
Parameters
- functionName: M
- Rest ...args: types.ActorMethodParameters<A[M]>
Returns Promise<types.ActorMethodReturnType<A[M]>>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:272

getActor

getActor(): null | A
Returns null | A
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:308

cleanup

cleanup(): void
Returns void
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/actor/index.ts:341

Class ActorManager<A>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns classes.ActorManager<A>

Properties

Private _actor

Private _idlFactory

Private _agentManager

Private _unsubscribeAgent

Type declaration

Returns void

Private _subscribers

Type declaration

Returns void

canisterId

actorStore

visitFunction

methodAttributes

getState

Type declaration

Returns types.ActorState<A>

subscribeActorState

Type declaration

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

Type Parameters

Parameters

Parameters

Returns U

Parameters

Returns void

Optional equalityFn?: ((a, b) => boolean)

Parameters

Returns boolean

Optional fireImmediately?: boolean

Returns (() => void)

Returns void

setState

Type declaration

Parameters

Returns void

Parameters

Returns void

Accessors

agentManager

Returns classes.AgentManager

Methods

Private updateState

Parameters

Returns void

updateMethodState

Parameters

Returns void

initialize

Parameters

Returns Promise<void>

extractInterface

Returns types.IDL.ServiceClass

extractMethodAttributes

Returns types.MethodAttributes<A>

extractVisitor

Returns types.VisitService<A>

Private initializeActor

Parameters

Returns void

Private _getActorMethod

Type Parameters

Parameters

Returns types.ActorMethodType<A, M>

`Private` _actor

`Private` _idlFactory

`Private` _agentManager

`Private` _unsubscribeAgent

`Private` _subscribers

`Optional` equalityFn?: ((a, b) => boolean)

`Optional` fireImmediately?: boolean

`Private` updateState

`Private` initializeActor

`Private` _getActorMethod