ic-reactor
    Preparing search index...

    Interface ActorConfig

    Configuration that can be passed to customize the Actor behaviour.

    interface ActorConfig {
        agent?: utils.agent.Agent;
        effectiveCanisterId?: types.Principal;
        nonce?: Uint8Array<ArrayBufferLike>;
        canisterId: string | types.Principal;
        blsVerify?: VerifyFunc;
        pollingOptions?: utils.agent.PollingOptions;
        callTransform(
            methodName: string,
            args: unknown[],
            callConfig: utils.agent.CallConfig,
        ): void | Partial<utils.agent.CallConfig>;
        queryTransform(
            methodName: string,
            args: unknown[],
            callConfig: utils.agent.CallConfig,
        ): void | Partial<utils.agent.CallConfig>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    agent? effectiveCanisterId? nonce? canisterId blsVerify? pollingOptions?

    Methods

    callTransform? queryTransform?

    Properties

    agent?: utils.agent.Agent

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

    effectiveCanisterId?: types.Principal

    The effective canister ID. This should almost always be ignored.

    nonce?: Uint8Array<ArrayBufferLike>

    The nonce to use for this call. This is used to prevent replay attacks.

    canisterId: string | types.Principal

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

    blsVerify?: VerifyFunc

    Polyfill for BLS Certificate verification in case wasm is not supported

    pollingOptions?: utils.agent.PollingOptions

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

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods