AssetManagerConfig
Defined in: assets/src/index.ts:117
Configuration that can be passed to set the canister id of the assets canister to be managed, inherits actor configuration and has additional asset manager specific configuration options.
Extends
Section titled “Extends”Properties
Section titled “Properties”agent?
Section titled “agent?”
optionalagent:Agent
Defined in: agent/lib/esm/actor.d.ts:14
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: agent/lib/esm/actor.d.ts:51
Polyfill for BLS Certificate verification in case wasm is not supported
Inherited from
Section titled “Inherited from”canisterId
Section titled “canisterId”canisterId:
string|Principal
Defined in: agent/lib/esm/actor.d.ts:39
The Canister ID of this Actor. This is required for an Actor.
Inherited from
Section titled “Inherited from”concurrency?
Section titled “concurrency?”
optionalconcurrency:number
Defined in: assets/src/index.ts:122
Max number of concurrent requests to the Internet Computer
Default
Section titled “Default”16effectiveCanisterId?
Section titled “effectiveCanisterId?”
optionaleffectiveCanisterId:Principal
Defined in: agent/lib/esm/actor.d.ts:26
The effective canister ID. This should almost always be ignored.
Inherited from
Section titled “Inherited from”ActorConfig.effectiveCanisterId
maxChunkSize?
Section titled “maxChunkSize?”
optionalmaxChunkSize:number
Defined in: assets/src/index.ts:132
Size of each chunk in bytes when the asset manager has to chunk a file
Default
Section titled “Default”1900000maxSingleFileSize?
Section titled “maxSingleFileSize?”
optionalmaxSingleFileSize:number
Defined in: assets/src/index.ts:127
Max file size in bytes that the asset manager shouldn’t chunk
Default
Section titled “Default”1900000nonce?
Section titled “nonce?”
optionalnonce:Uint8Array<ArrayBufferLike>
Defined in: agent/lib/esm/actor.d.ts:30
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: agent/lib/esm/actor.d.ts:55
Polling options to use when making update calls. This will override the default DEFAULT_POLLING_OPTIONS.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”callTransform()?
Section titled “callTransform()?”
optionalcallTransform(methodName,args,callConfig):void|Partial<CallConfig>
Defined in: agent/lib/esm/actor.d.ts:43
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>
Inherited from
Section titled “Inherited from”queryTransform()?
Section titled “queryTransform()?”
optionalqueryTransform(methodName,args,callConfig):void|Partial<CallConfig>
Defined in: agent/lib/esm/actor.d.ts:47
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>