Interface CreateActorContextType<A>

interface CreateActorContextType<A> {
    useInitializeActor?: (() => InitializeActor);
    initialize: (() => Promise<void>);
    useActorStore: UseActorStore<A>;
    useActorState: (() => UseActorStateReturnType);
    useActorInterface: (() => types.IDL.ServiceClass);
    useMethodNames: (<Actor>() => Extract<keyof Actor, string>[]);
    useMethodAttributes: (<Actor>() => types.MethodAttributes<Actor>);
    useMethod: UseMethod<A>;
    useQueryCall: UseQueryCall<A>;
    useUpdateCall: UseUpdateCall<A>;
    useVisitMethod: UseVisitMethod<A>;
    useVisitService: UseVisitService<A>;
}

Type Parameters

A = types.BaseActor

Hierarchy (view full)

ActorHooksReturnType<A>
- CreateActorContextType

Index

Properties

useInitializeActor? initialize useActorStore useActorState useActorInterface useMethodNames useMethodAttributes useMethod useQueryCall useUpdateCall useVisitMethod useVisitService

Properties

`Optional` useInitializeActor

useInitializeActor?: (() => InitializeActor)

Type declaration

- (): InitializeActor
- Returns InitializeActor

initialize

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

Type declaration

- (): Promise<void>
- Returns Promise<void>

useActorStore

useActorStore: UseActorStore<A>

useActorState

useActorState: (() => UseActorStateReturnType)

Type declaration

- (): UseActorStateReturnType
- Returns UseActorStateReturnType

useActorInterface

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

Type declaration

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

useMethodNames

useMethodNames: (<Actor>() => Extract<keyof Actor, string>[])

Type declaration

- <Actor>(): Extract<keyof Actor, string>[]
- Type Parameters
  - Actor = A
  Returns Extract<keyof Actor, string>[]

useMethodAttributes

useMethodAttributes: (<Actor>() => types.MethodAttributes<Actor>)

Type declaration

- <Actor>(): types.MethodAttributes<Actor>
- Type Parameters
  - Actor = A
  Returns types.MethodAttributes<Actor>

useMethod

useMethod: UseMethod<A>

useQueryCall

useQueryCall: UseQueryCall<A>

useUpdateCall

useUpdateCall: UseUpdateCall<A>

useVisitMethod

useVisitMethod: UseVisitMethod<A>

useVisitService

useVisitService: UseVisitService<A>