Skip to content

QueryCallOptions

Defined in: packages/pic/src/pocket-ic-types.ts:939

Options for making a query call to a given canister.

Principal

optional arg: Uint8Array<ArrayBufferLike>

Defined in: packages/pic/src/pocket-ic-types.ts:960

A Candid encoded argument to pass to the canister’s method. Defaults to an empty Uint8Array.


canisterId: Principal

Defined in: packages/pic/src/pocket-ic-types.ts:949

The Principal of the canister to query.


method: string

Defined in: packages/pic/src/pocket-ic-types.ts:954

The method to call on the canister.


optional sender: Principal

Defined in: packages/pic/src/pocket-ic-types.ts:944

The Principal to send the request as. Defaults to the anonymous principal.


optional senderInfo: SenderInfo

Defined in: packages/pic/src/pocket-ic-types.ts:970

Sender information to attach to the call, see SenderInfo.


optional targetSubnetId: Principal

Defined in: packages/pic/src/pocket-ic-types.ts:965

The ID of the subnet that the canister resides on.