Class SeamHttpRequest<TResponse, TResponseKey>

constructor

• new SeamHttpRequest<
      const TResponse,
      const TResponseKey extends string | number | symbol | undefined,
  >(
      parent: SeamHttpRequestParent,
      config: SeamHttpRequestConfig<TResponseKey>,
  ): SeamHttpRequest<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol | undefined

  Parameters

  • parent: SeamHttpRequestParent
  • config: SeamHttpRequestConfig<TResponseKey>

  Returns SeamHttpRequest<TResponse, TResponseKey>

Readonly[toStringTag]

body

• get body(): unknown

  The body sent with the request, if any.

  Returns unknown

method

• get method(): Method

  The HTTP request method.

  Returns Method

params

• get params(): Record<string, unknown> | undefined

  The query parameters sent with the request, if any.

  Returns Record<string, unknown> | undefined

pathname

• get pathname(): string

  The request pathname, e.g., /devices/get.

  Returns string

responseKey

• get responseKey(): TResponseKey

  The key of the API response object containing the response data, or undefined if the endpoint returns an empty response.

  Returns TResponseKey

url

• get url(): URL

  The full request URL including any serialized query parameters.

  Returns URL

catch

• catch<TResult = never>(
      onrejected?:
          | ((reason: unknown) => TResult | PromiseLike<TResult>)
          | null,
  ): Promise<
      | TResult
      | (
          TResponseKey extends keyof TResponse
              ? TResponse[TResponseKey]
              : undefined
      ),
  >

  Executes the request and handles any rejection with onrejected. Enables awaiting a SeamHttpRequest like a Promise.

  Type Parameters

  • TResult = never

  Parameters

  • Optionalonrejected: ((reason: unknown) => TResult | PromiseLike<TResult>) | null

  Returns Promise<
      | TResult
      | (
          TResponseKey extends keyof TResponse
              ? TResponse[TResponseKey]
              : undefined
      ),
  >

execute

• execute(): Promise<
      TResponseKey extends keyof TResponse
          ? TResponse[TResponseKey]
          : undefined,
  >

  Sends the request and returns the response data. If the response contains an action attempt, waits for the action attempt to resolve according to the waitForActionAttempt option.

  Returns Promise<
      TResponseKey extends keyof TResponse
          ? TResponse[TResponseKey]
          : undefined,
  >

fetchResponse

• fetchResponse(): Promise<TResponse>

  Sends the request and returns the entire response body without waiting for any action attempt to resolve.

  Returns Promise<TResponse>

finally

• finally(
      onfinally?: (() => void) | null,
  ): Promise<
      TResponseKey extends keyof TResponse
          ? TResponse[TResponseKey]
          : undefined,
  >

  Executes the request and calls onfinally once the request settles. Enables awaiting a SeamHttpRequest like a Promise.

  Parameters

  • Optionalonfinally: (() => void) | null

  Returns Promise<
      TResponseKey extends keyof TResponse
          ? TResponse[TResponseKey]
          : undefined,
  >

then

• then<
      TResult1 = TResponseKey extends keyof TResponse
          ? TResponse[TResponseKey]
          : undefined,
      TResult2 = never,
  >(
      onfulfilled?:
          | (
              (
                  value: TResponseKey extends keyof TResponse
                      ? TResponse[TResponseKey]
                      : undefined,
              ) => TResult1
              | PromiseLike<TResult1>
          )
          | null,
      onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
  ): Promise<TResult1 | TResult2>

  Executes the request and resolves with the response data. Enables awaiting a SeamHttpRequest like a Promise.

  Type Parameters

  • TResult1 = TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined
  • TResult2 = never

  Parameters

  • Optionalonfulfilled:
        | (
            (
                value: TResponseKey extends keyof TResponse
                    ? TResponse[TResponseKey]
                    : undefined,
            ) => TResult1
            | PromiseLike<TResult1>
        )
        | null
  • Optionalonrejected: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null

  Returns Promise<TResult1 | TResult2>