Class ActorManager<A>

Type Parameters

A = types.BaseActor

Constructors

constructor

new ActorManager<A>(actorConfig): types.ActorManager<A>
Type Parameters
- A = types.BaseActor
Parameters
- actorConfig: types.ActorManagerParameters
Returns types.ActorManager<A>
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@ic-reactor-core-virtual-8912d6d033/1/packages/core/dist/classes/actor/index.d.ts:18

Properties

`Private` _actor

_actor: any

`Private` _idlFactory

_idlFactory: any

`Private` _agentManager

_agentManager: any

`Private` _unsubscribeAgent

_unsubscribeAgent: any

`Private` _subscribers

_subscribers: any

canisterId

canisterId: string

`Private` updateState

updateState: any

updateMethodState

updateMethodState: ((method, hash, newState) => void)

Type declaration

- (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

initialize

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

Type declaration

- (options?): Promise<void>
- Parameters
  - Optional options: types.UpdateAgentParameters
  Returns Promise<void>

extractInterface

extractInterface: (() => types.IDL.ServiceClass)

Type declaration

- (): types.IDL.ServiceClass
- Returns types.IDL.ServiceClass

extractMethodAttributes

extractMethodAttributes: (() => types.MethodAttributes<A>)

Type declaration

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

extractVisitor

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

Type declaration

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

`Private` initializeActor

initializeActor: any

`Private` _getActorMethod

_getActorMethod: any

callMethod

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

Type declaration

- <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]>>

callMethodWithOptions

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

Type declaration

- (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]>>

call

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

Type declaration

- <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]>>

getActor

getActor: (() => null | A)

Type declaration

- (): null | A
- Returns null | A

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

cleanup

cleanup: (() => void)

Type declaration

- (): void
- Returns void

Accessors

agentManager

get agentManager(): types.AgentManager
Returns types.AgentManager
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@ic-reactor-core-virtual-8912d6d033/1/packages/core/dist/classes/actor/index.d.ts:28

Class ActorManager<A>

Type Parameters

Index

Constructors

Properties

Accessors

Constructors

constructor

Type Parameters

Parameters

Returns types.ActorManager<A>

Properties

Private _actor

Private _idlFactory

Private _agentManager

Private _unsubscribeAgent

Private _subscribers

canisterId

actorStore

visitFunction

methodAttributes

Private updateState

updateMethodState

Type declaration

Parameters

Returns void

initialize

Type declaration

Parameters

Returns Promise<void>

extractInterface

Type declaration

Returns types.IDL.ServiceClass

extractMethodAttributes

Type declaration

Returns types.MethodAttributes<A>

extractVisitor

Type declaration

Returns types.VisitService<A>

Private initializeActor

Private _getActorMethod

callMethod

Type declaration

Type Parameters

Parameters

Returns Promise<types.ActorMethodReturnType<A[M]>>

callMethodWithOptions

Type declaration

Parameters

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

Type Parameters

Parameters

Returns Promise<types.ActorMethodReturnType<A[M]>>

call

Type declaration

Type Parameters

Parameters

Returns Promise<types.ActorMethodReturnType<A[M]>>

getActor

Type declaration

Returns null | A

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

`Private` _actor

`Private` _idlFactory

`Private` _agentManager

`Private` _unsubscribeAgent

`Private` _subscribers

`Private` updateState

`Private` initializeActor

`Private` _getActorMethod

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

`Optional` fireImmediately?: boolean