Interface FetcherRequestInfo

Overview

The JSON.stringify-ed body of the request, if applicable.

The content-type header is already present in FetcherResponseInfo.headers, so it's not necessary to set it yourself.

Overview

Whether to force HTTP/1[.1] for the request.

Why this is important

The DevOps API does not support HTTP/2, so such requests must only use HTTP/1 or HTTP/1.1.

Overview

The base headers to include in the request.

• These headers are preconfigured but may be modified or overridden as necessary.
• Ensure that required headers are correctly forwarded.

Included headers

Already included headers include:

• Basic headers such as:
  • content-type
  • user-agent
• Authorization headers, such as Authorization or Token, from token options
  • e.g. DataAPIClient, DbOptions.token, or AdminOptions.adminToken
• Any headers from embeddingApiKey options
  • e.g. CollectionOptions.embeddingApiKey or TableOptions.embeddingApiKey
• Any headers from any additionalHeaders options
  • e.g. DbOptions.additionalHeaders or AdminOptions.additionalHeaders

Overview

The HTTP method to use for the request.

Currently used methods:

• GET
• POST
• DELETE

Future updates may require additional methods.

Overview

Creates a standardized timeout error for the request.

• If the request times out, you should catch the timeout error first and throw the result of this method.
• This ensures a consistent error format across different fetch implementations.

Example

As an example, this is how the FetchNative implementation handles timeouts:

Example

public async fetch(info: FetcherRequestInfo): Promise<FetcherResponseInfo> {
  try {
    const resp = await fetch(info.url, {
      signal: AbortSignal.timeout(info.timeout),
      ...,
    });
  } catch (e) {
    if (e instanceof Error && e.name === 'TimeoutError') {
      throw info.mkTimeoutError();
    }
    throw e;
  }
}
Copy

Of course, some http clients may offer a more straightforward way to handle timeouts, such as axios's timeout option, and may have different ways to express timeouts occurring.

Whatever the case, they should be appropriately set & handled to ensure the timeout is respected.

Overview

The timeout duration for the request, in milliseconds.

Important

• You must respect this timeout using AbortSignal or another valid timeout mechanism.
• If the request exceeds this timeout, throw the error generated by mkTimeoutError().

See FetcherRequestInfo.mkTimeoutError for more information on how to handle timeouts.

Overview

The full URL to which the request should be made.

This URL is preformatted, and already includes any necessary query parameters.