ActorConfig
Defined in: packages/agent/src/actor.ts:60
Configuration that can be passed to customize the Actor behaviour.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”agent?
Section titled “agent?”
optionalagent:Agent
Defined in: packages/agent/src/actor.ts:34
An agent to use in this call, otherwise the actor or call will try to discover the agent to use.
Inherited from
Section titled “Inherited from”blsVerify?
Section titled “blsVerify?”
optionalblsVerify:VerifyFunc
Defined in: packages/agent/src/actor.ts:87
Polyfill for BLS Certificate verification in case wasm is not supported
canisterId
Section titled “canisterId”canisterId:
string|Principal
Defined in: packages/agent/src/actor.ts:64
The Canister ID of this Actor. This is required for an Actor.
Overrides
Section titled “Overrides”effectiveCanisterId?
Section titled “effectiveCanisterId?”
optionaleffectiveCanisterId:Principal
Defined in: packages/agent/src/actor.ts:49
The effective canister ID. This should almost always be ignored.
Inherited from
Section titled “Inherited from”CallConfig.effectiveCanisterId
nonce?
Section titled “nonce?”
optionalnonce:Uint8Array<ArrayBufferLike>
Defined in: packages/agent/src/actor.ts:54
The nonce to use for this call. This is used to prevent replay attacks.
Inherited from
Section titled “Inherited from”pollingOptions?
Section titled “pollingOptions?”
optionalpollingOptions:PollingOptions
Defined in: packages/agent/src/actor.ts:92
Polling options to use when making update calls. This will override the default DEFAULT_POLLING_OPTIONS.
Overrides
Section titled “Overrides”Methods
Section titled “Methods”callTransform()?
Section titled “callTransform()?”
optionalcallTransform(methodName,args,callConfig):void|Partial<CallConfig>
Defined in: packages/agent/src/actor.ts:69
An override function for update calls’ CallConfig. This will be called on every calls.
Parameters
Section titled “Parameters”methodName
Section titled “methodName”string
unknown[]
callConfig
Section titled “callConfig”Returns
Section titled “Returns”void | Partial<CallConfig>
queryTransform()?
Section titled “queryTransform()?”
optionalqueryTransform(methodName,args,callConfig):void|Partial<CallConfig>
Defined in: packages/agent/src/actor.ts:78
An override function for query calls’ CallConfig. This will be called on every query.
Parameters
Section titled “Parameters”methodName
Section titled “methodName”string
unknown[]
callConfig
Section titled “callConfig”Returns
Section titled “Returns”void | Partial<CallConfig>