Class SeamHttpRequest<TResponse, TResponseKey>

constructor

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

  Type Parameters

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

  Parameters

  • parent: SeamHttpRequestParent
  • config: SeamHttpRequestConfig<TResponseKey>

  Returns SeamHttpRequest<TResponse, TResponseKey>

Readonly[toStringTag]

body

• get body(): unknown

  Returns unknown

method

• get method(): Method

  Returns Method

params

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

  Returns undefined | Record<string, unknown>

pathname

• get pathname(): string

  Returns string

responseKey

• get responseKey(): TResponseKey

  Returns TResponseKey

url

• get url(): URL

  Returns URL

catch

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

  Attaches a callback for only the rejection of the Promise.

  Type Parameters

  • TResult = never

  Parameters

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

    The callback to execute when the Promise is rejected.

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

  A Promise for the completion of the callback.

execute

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

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

fetchResponse

• fetchResponse(): Promise<TResponse>

  Returns Promise<TResponse>

finally

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

  Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

  Parameters

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

    The callback to execute when the Promise is settled (fulfilled or rejected).

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

  A Promise for the completion of the callback.

then

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

  Attaches callbacks for the resolution and/or rejection of the Promise.

  Type Parameters

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

  Parameters

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

    The callback to execute when the Promise is resolved.
  • Optionalonrejected: null | ((reason: unknown) => TResult2 | PromiseLike<TResult2>)

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult1 | TResult2>

  A Promise for the completion of which ever callback is executed.