ActorConfig

Defined in: packages/agent/src/actor.ts:61

Configuration that can be passed to customize the Actor behavior.

Extends

Pick<CallConfig, "agent" | "effectiveCanisterId">

Properties

agent?

optional agent: Agent

Defined in: packages/agent/src/actor.ts:35

An agent to use in this call, otherwise the actor or call will try to discover the agent to use.

Inherited from

CallConfig.agent

blsVerify?

optional blsVerify: VerifyFunc

Defined in: packages/agent/src/actor.ts:88

Polyfill for BLS Certificate verification in case wasm is not supported

canisterId

canisterId: string | Principal

Defined in: packages/agent/src/actor.ts:65

The Canister ID of this Actor. This is required for an Actor.

effectiveCanisterId?

optional effectiveCanisterId: Principal

Defined in: packages/agent/src/actor.ts:50

The effective canister ID.

Inherited from

CallConfig.effectiveCanisterId

pollingOptions?

optional pollingOptions: PollingOptions

Defined in: packages/agent/src/actor.ts:93

Polling options to use when making update calls. This will override the default DEFAULT_POLLING_OPTIONS.

Methods

callTransform()?

optional callTransform(methodName, args, callConfig): void | Partial<CallConfig>

Defined in: packages/agent/src/actor.ts:70

An override function for update calls’ CallConfig. This will be called on every calls.

Parameters

methodName

string

args

unknown[]

callConfig

CallConfig

Returns

void | Partial<CallConfig>

queryTransform()?

optional queryTransform(methodName, args, callConfig): void | Partial<CallConfig>

Defined in: packages/agent/src/actor.ts:79

An override function for query calls’ CallConfig. This will be called on every query.