Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpAgentOptions

Hierarchy

  • HttpAgentOptions

Index

Properties

Properties

Optional backoffStrategy

backoffStrategy?: BackoffStrategyFactory

The strategy to use for backoff when retrying requests

Optional callOptions

callOptions?: Record<string, unknown>

Optional credentials

credentials?: { name: string; password?: string }

Type declaration

  • name: string
  • Optional password?: string

Optional fetch

fetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response> }

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
    • (input: string | Request | URL, init?: RequestInit): Promise<Response>

    • Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    • Parameters

      • input: string | Request | URL
      • Optional init: RequestInit

      Returns Promise<Response>

Optional fetchOptions

fetchOptions?: Record<string, unknown>

Optional host

host?: string

Optional identity

identity?: Identity | Promise<Identity>

Optional ingressExpiryInMinutes

ingressExpiryInMinutes?: number

The maximum time a request can be delayed before being rejected.

default

5 minutes

Optional logToConsole

logToConsole?: boolean

Whether to log to the console. Defaults to false.

Optional retryTimes

retryTimes?: number

Number of times to retry requests before throwing an error

default

3

Optional rootKey

rootKey?: ArrayBuffer

Alternate root key to use for verifying certificates. If not provided, the default IC root key will be used.

Optional shouldFetchRootKey

shouldFetchRootKey?: boolean

Whether or not the root key should be automatically fetched during construction.

Optional useQueryNonces

useQueryNonces?: boolean

Adds a unique Nonce with each query. Enabling will prevent queries from being answered with a cached response.

example

const agent = new HttpAgent({ useQueryNonces: true }); agent.addTransform(makeNonceTransform(makeNonce);

default

false

Optional verifyQuerySignatures

verifyQuerySignatures?: boolean

Whether the agent should verify signatures signed by node keys on query responses. Increases security, but adds overhead and must make a separate request to cache the node keys for the canister's subnet.

default

true

Generated using TypeDoc